Skip to content

Fix Sphinx docs rendering by repairing missing figure assets and references#21

Draft
eshasadia with Copilot wants to merge 6 commits into
mainfrom
copilot/check-sphinx-doc-issue
Draft

Fix Sphinx docs rendering by repairing missing figure assets and references#21
eshasadia with Copilot wants to merge 6 commits into
mainfrom
copilot/check-sphinx-doc-issue

Conversation

Copilot AI commented May 20, 2026

Copy link
Copy Markdown
Contributor

The documentation pages were rendering with broken/missing figures because the referenced image files under docs/_static/images/*.svg did not exist in the repo. This PR aligns figure references with versioned assets so pages render consistently.

  • Root cause addressed

    • Replaced broken figure paths in:
      • docs/index.rst
      • docs/quickstart.rst
    • Paths now point to a tracked static asset instead of non-existent SVG files.
  • Docs asset normalization

    • Added docs/_static/images/overall.png as the in-repo image source used by docs pages.
    • Updated .gitignore to allow versioning docs static PNG assets (!docs/_static/images/*.png).
  • Content accuracy cleanup

    • Removed repeated quickstart figure blocks whose captions/alt-text implied specialized visuals that were not actually present, avoiding misleading documentation until dedicated assets are added.
.. figure:: _static/images/overall.png
   :alt: CORE pipeline overview
   :align: center
   :width: 100%

Copilot AI and others added 6 commits May 20, 2026 06:23
Agent-Logs-Url: https://github.com/eshasadia/CORE/sessions/c1e2af11-9ec4-477b-a234-3ec5d1575034

Co-authored-by: eshasadia <45667822+eshasadia@users.noreply.github.com>
Agent-Logs-Url: https://github.com/eshasadia/CORE/sessions/c1e2af11-9ec4-477b-a234-3ec5d1575034

Co-authored-by: eshasadia <45667822+eshasadia@users.noreply.github.com>
Agent-Logs-Url: https://github.com/eshasadia/CORE/sessions/c1e2af11-9ec4-477b-a234-3ec5d1575034

Co-authored-by: eshasadia <45667822+eshasadia@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants