Skip to content

docs: simplify guides and add documentation navigation - #195

Merged
Muneer320 merged 2 commits into
masterfrom
codex/docs-navigation-cleanup
Nov 20, 2026
Merged

Muneer320 merged 2 commits into
masterfrom
codex/docs-navigation-cleanup

Conversation

@Muneer320

@Muneer320 Muneer320 commented Nov 20, 2026 •

Copy link
Copy Markdown
Owner

Changes

Public docs mix a branding brief, a version-specific release checklist and completed CodeQL migration instructions with the maintained guides. Add a docs navigation index, remove BRANDING.md, and fold needed icon-export details into the website guide. Merge release checks into PACKAGING.md and remove RELEASE_READINESS.md.

Also remove duplicate measurement caveats and internal design/search-dashboard notes, refresh the qualification-tool description, and use first-person project-history/contact prose. Platform setup, configuration, security, licensing and contributor guidance remain. All references to the removed pages are updated; the root README links to the docs index and tells the project origin in first person.

Closes #194.

Validation

  • Repository documentation/link checks and diff checks pass.
  • 19 existing documentation, CI-scope and APT tests pass.
  • Website and axe accessibility checks pass at 320/360/768/1440 in light/dark, including guide links, overflow, focus and runtime errors.
  • Independent review found no actionable issues. The final head 389bfcf passed hosted CI, package/site validation and all five CodeQL analyses after rebasing onto feat: add channel-aware updates and tray checks #193 and adding the first-person README paragraph. No unresolved review threads.

No application code or release artifacts change.

@coderabbitai

coderabbitai Bot commented Nov 20, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 27 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 7bf079da-ed90-4b11-8691-dc78c23a18f3
Commits

Reviewing files that changed from the base of the PR and between ff80f2f and 389bfcf.

Files selected for processing: 17

  • ACKNOWLEDGEMENTS.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • README.md
  • docs/ARCHITECTURE.md
  • docs/BENCHMARKS.md
  • docs/BRANDING.md
  • docs/CHARACTER.md
  • docs/MAINTAINING_APT.md
  • docs/PACKAGING.md
  • docs/README.md
  • docs/RELEASE_READINESS.md
  • docs/WEBSITE.md
  • docs/WINDOWS.md
  • docs/WINDOWS_STORE.md
  • packaging/apt/guide.html
  • tools/windows-qualification/USAGE.md
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@Muneer320
Muneer320 force-pushed the codex/docs-navigation-cleanup branch from 2726cd1 to 389bfcf Compare November 20, 2026 22:27
@Muneer320
Muneer320 merged commit a84a72b into master Nov 20, 2026
22 checks passed
@Muneer320
Muneer320 deleted the codex/docs-navigation-cleanup branch November 20, 2026 22:41
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.

Simplify public documentation and add a navigation index

1 participant