Skip to content

docs: update documentation structure#128

Merged
adohe merged 1 commit into
mainfrom
feat/docs-structure
Jul 3, 2026
Merged

docs: update documentation structure#128
adohe merged 1 commit into
mainfrom
feat/docs-structure

Conversation

@adohe

@adohe adohe commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Summary:

  • reorganize the documentation navigation into the current visible sections
  • add collapsible sidebar groups and refine sidebar scrollbar/search/menu styling
  • add focused getting started, concepts, cookbook, reference, and troubleshooting pages

Verification:

  • .venv/bin/sphinx-build -E -a -b html docs /private/tmp/areno-docs-preview

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request significantly updates the documentation structure for the AReno project, introducing new conceptual guides, cookbooks, and a troubleshooting section, while also adding a new collapsible sidebar feature for improved navigation. The code review provides a valuable improvement to the sidebar functionality, suggesting that sections should default to collapsed unless they contain the active page, which I have included in the feedback summary.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread docs/_static/areno-sidebar.js

@xsuler xsuler left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@adohe adohe merged commit 013b53d into main Jul 3, 2026
2 checks passed
@adohe adohe deleted the feat/docs-structure branch July 3, 2026 06:05
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