Docs reorg

.github/ISSUE_TEMPLATES/documentation-feedback.md

@@ -0,0 +1,35 @@
+---
+name: Documentation Feedback
+about: Report errors, suggest improvements, or request clarification in documentation
+title: '[DOCS] '
+labels: documentation
+assignees: ''
+---
+
+## Documentation Issue
+
+**Page URL:** 
+<!-- Link to the specific documentation page -->
+
+**Issue Type:**
+- [ ] Error/Typo
+- [ ] Unclear explanation
+- [ ] Missing information
+- [ ] Outdated content
+- [ ] Other
+
+**Description:**
+<!-- Clear description of the issue -->
+
+**Suggested Fix:**
+<!-- If you have a suggestion for how to improve this -->
+
+**User Context:**
+- [ ] Chameleon PI
+- [ ] Student user
+- [ ] Researcher/Faculty
+- [ ] External collaborator
+- [ ] Other: ___________
+
+**Additional Context:**
+<!-- Any other relevant information -->

source/_static/css/style.css

@@ -3,14 +3,59 @@
     font-weight: bold;
 }
 
-.figure.screenshot {
-    max-width: 440px;
-    border: 1px solid #eeeeee;
-    box-shadow: 0 .1rem .5rem rgba(0, 0, 0, 0.1);
-    padding: .5rem;
-} .figure.screenshot .caption {
+/* Uniform styling for all documentation images */
+img {
+    max-width: 800px;
+    max-height: 500px;
+    width: auto;
+    height: auto;
+    object-fit: contain;
+    border: 1px solid #d1d5da;
+    border-radius: 4px;
+    box-shadow: 0 2px 8px rgba(0, 0, 0, 0.1);
+    margin: 1rem auto;
+    display: block;
+    background: #fff;
+    padding: 0.5rem;
+}
+
+img:hover {
+    box-shadow: 0 4px 12px rgba(0, 0, 0, 0.15);
+}
+
+/* Keep figure styling for captions when figures are used */
+.figure {
+    max-width: 820px;
+    margin: 2rem auto;
+    text-align: center;
+}
+
+.figure img {
+    margin: 0;
+}
+
+.figure .caption {
     text-align: left;
-    margin-top: .5rem;
-    font-size: 12px;
-    line-height: 1em;
+    margin-top: 0.75rem;
+    font-size: 0.85rem;
+    color: #586069;
+    line-height: 1.3;
+    font-style: normal;
+}
+
+/* Responsive behavior */
+@media (max-width: 768px) {
+    img {
+        max-width: 95%;
+        padding: 0.25rem;
+        margin: 0.5rem auto;
+    }
+
+    .figure {
+        max-width: 95%;
+    }
+
+    .figure .caption {
+        font-size: 0.8rem;
+    }
 }

source/_static/js/rate-the-docs-config.js

@@ -0,0 +1,24 @@
+window.rateTheDocs = {
+  // Send events to your existing GA property
+  onRate: function(rating, page) {
+    if (typeof gtag !== 'undefined') {
+      gtag('event', 'rate_documentation', {
+        'rating': rating,
+        'page_title': document.title,
+        'page_location': window.location.href,
+        'custom_parameter': 'helpful_' + (rating > 3 ? 'yes' : 'no')
+      });
+    }
+  },
+
+  onFeedback: function(feedback, rating, page) {
+    if (typeof gtag !== 'undefined') {
+      gtag('event', 'documentation_feedback', {
+        'feedback_text': feedback.substring(0, 100), // Truncate for GA
+        'rating': rating,
+        'page_title': document.title,
+        'page_location': window.location.href
+      });
+    }
+  }
+};

source/_templates/footer.html

@@ -0,0 +1,8 @@
+<div class="feedback-box" style="margin: 20px 0; padding: 15px; background: #f8f9fa; border-left: 4px solid #0066cc;">
+    <p>
+        <strong>Improve this page:</strong>
+        <a href="https://github.com/chameleoncloud/docs/issues/new?title=Issue%20with%20page:%20{{ title|urlencode }}" target="_blank">
+            Report an issue or suggest improvements
+        </a>
+    </p>
+</div>

source/conf.py

@@ -52,7 +52,7 @@
 
 # General information about the project.
 project = 'Chameleon Cloud Documentation'
-copyright = '2018, Chameleon Cloud'
+copyright = '2025, Chameleon Cloud'
 author = 'Chameleon Cloud'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -85,6 +85,9 @@
 rst_prolog = """
 .. |CHI@TACC| replace:: `CHI@TACC <https://chi.tacc.chameleoncloud.org>`__
 .. |CHI@UC| replace:: `CHI@UC <https://chi.uc.chameleoncloud.org>`__
+.. |CHI@NCAR| replace:: `CHI@NCAR <https://chi.hpc.ucar.edu>`__
+.. |CHI@Edge| replace:: `CHI@Edge <https://chi.edge.chameleoncloud.org>`__
+.. |CHI@NRP| replace:: `CHI@NRP <https://chi.nrp.ai>`__
 .. |KVM@TACC| replace:: `KVM@TACC <https://kvm.tacc.chameleoncloud.org>`__
 .. |Appliance Catalog| replace:: `Appliance Catalog <https://www.chameleoncloud.org/appliances/>`__
 .. |Home| replace:: `chameleoncloud.org <https://www.chameleoncloud.org/>`__
@@ -105,9 +108,6 @@
 #html_theme = 'sphinxdoc'
 html_theme = 'sphinx_rtd_theme'
 
-def setup(app):
-    app.add_css_file("css/style.css")
-
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
@@ -196,3 +196,18 @@ def setup(app):
 #      author, 'ChameleonCloudDocumentation', 'One line description of project.',
 #      'Miscellaneous'),
 # ]
+
+html_context = {
+    "display_github": True,
+    "github_user": "ChameleonCloud",
+    "github_repo": "docs",
+    "github_version": "master",
+    "conf_py_path": "/source/",
+}
+
+
+
+def setup(app):
+    app.add_css_file("css/style.css")
+    app.add_js_file("https://unpkg.com/rate-the-docs")
+    app.add_js_file("js/rate-the-docs-config.js")

source/contents.rst

@@ -3,14 +3,14 @@ Welcome to Chameleon
 =====================
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :caption: Introduction
 
    index
    getting-started/index
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :caption: Users and Projects
 
    user/federation
@@ -20,29 +20,28 @@ Welcome to Chameleon
    user/help
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :caption: Testbed interfaces
 
-   technical/gui
-   technical/cli
-   technical/jupyter
+   technical/gui/index
+   technical/cli/index
+   technical/jupyter/index
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :caption: Technical guide
 
    technical/index
-   technical/discovery
-   technical/reservations
-   technical/baremetal
-   technical/images
-   technical/metrics
-   technical/complex
-   technical/swift
-   technical/shares
-   technical/networks
-   technical/fpga
-   technical/ep
-   technical/sharing
-   technical/daypass
-   technical/kvm
+   technical/discovery/index
+   technical/reservations/index
+   technical/baremetal/index
+   technical/images/index
+   technical/power_monitoring/index
+   technical/complex/index
+   technical/swift/index
+   technical/shares/index
+   technical/networks/index
+   technical/fpga/index
+   technical/sharing/index
+   technical/daypass/index
+   technical/kvm/index