css-tidyup minor components

Author: osfameron

src/css/clipboard.css

@@ -1,3 +1,9 @@
+/** clipboard.css
+ * 
+ *  Styles for View Source code button
+ *  and other listing block formatting
+ */
+
 .view-source-button,
 .copy-code-button {
   color: var(--color-brand-gray4);

src/css/component-frame.css

@@ -1,3 +1,9 @@
+/** component-frame.css
+ * 
+ *  .component-frame and .frame-body
+ *  NB: may be unused, deleted in 4d2db54746392090df7084978770f58f4709e56c ?
+ */
+
 .component-frame {
   background: var(--color-brand-gray6);
   padding: 0 15px 0 15px;

src/css/crumbs.css

@@ -1,3 +1,8 @@
+/** crumbs.css
+ * 
+ *  Format the breadcrumbs 
+ */
+
 .crumbs {
   color: var(--color-muted);
   font-weight: var(--weight-light);

src/css/external-link-icon.css

@@ -1,3 +1,8 @@
+/** external-link-icon.css
+ * 
+ *  Add external link icon to links that aren't to couchbase.com
+ */
+
 .doc a[href^="https://"]:not([href*=".couchbase.com"]):not([href*="localhost"]):not([href*="127.0.0.1"]):not(.remove-ext-icon)::after,
 .doc a[href^="http://"]:not([href*=".couchbase.com"]):not([href*="localhost"]):not([href*="127.0.0.1"]):not(.remove-ext-icon)::after,
 a.add-ext-icon::after {

src/css/feedback.css

@@ -1,4 +1,9 @@
-/* these elements are created by Jira Issue Collector script */
+/** feedback.css
+ * 
+ *  I believe these elements are created by 
+ *  Jira Issue Collector script.
+ *  e.g. we don't output these in docs-ui
+ */
 
 #atlwdg-trigger.atlwdg-trigger {
   display: none;

src/css/highlight.css

@@ -1,4 +1,5 @@
-/**
+/** highlight.css
+
 Steps to change the highlight.js theme:
 
 1. View available themes on https://highlightjs.org/static/demo/

src/css/home.css

@@ -1,3 +1,14 @@
+/** home.css
+ * 
+ *  Styles for .home
+ *  NB: not sure where this is? Landing pages?
+ *  We can have body, div, main with class of .home
+ *  via layout: home
+ *  But grep suggests this may no longer be used.
+ *  
+ *  Also for .tutorials and .searchbar
+ */
+
 .home .paragraph {
   margin-top: 1.25rem;
 }

src/css/info-banner.css

@@ -1,5 +1,14 @@
-/* styles include::home::partial$info-banner.adoc[]
-  which includes an `[.info-banner]` section */
+/** info-banner.css
+ * 
+ * Home pages all have
+ *
+ *    include::home::partial$info-banner.adoc[]
+ * 
+ * The partial itself may be switched off
+ * (e.g. commented out)
+ * to remove the element from all pages.
+ *
+ */
 
 .info-banner {
   display: block;

src/css/is-this-helpful.css

@@ -1,3 +1,8 @@
+/** is-this-helpful.css
+ * 
+ *  Style the Is this helpful? thumbs up/down feature
+ *  in the table of contents
+ */
 
 .is-this-helpful-box * {
   font-family: "Source Sans Pro", sans-serif;

src/css/labels.css

@@ -1,3 +1,8 @@
+/** labels.css
+ * 
+ * doc .labels, .edition, .status
+ */
+
 .doc .labels ul,
 .doc .labels p {
   display: flex;