Skip to content

Fix documentation inconsistencies and errors#132

Merged
alexec merged 4 commits into
mainfrom
copilot/fix-documentation-errors
Dec 2, 2025
Merged

Fix documentation inconsistencies and errors#132
alexec merged 4 commits into
mainfrom
copilot/fix-documentation-errors

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Dec 2, 2025

Documentation review revealed outdated structure references, incorrect theme information, and a formatting error.

Changes

  • docs/README.md: Updated file structure to reflect actual Diataxis layout (tutorials/, how-to/, reference/, explanation/). Fixed theme from "Cayman" to "Just the Docs" per _config.yml. Updated Gemfile and navigation section accordingly.

  • docs/reference/search-paths.md: Removed stray closing code block marker causing rendering issues.

Original prompt

Thoroughly review all the docs and make corrections.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

…x language capitalization, remove stray code block

Co-authored-by: alexec <1142830+alexec@users.noreply.github.com>
Copilot AI changed the title [WIP] Review and correct documentation errors Fix documentation inconsistencies and errors Dec 2, 2025
Copilot AI requested a review from alexec December 2, 2025 05:30
@alexec
Copy link
Copy Markdown
Contributor

alexec commented Dec 2, 2025

@copilot Programming languages should always be lower case.

…lowercase

Co-authored-by: alexec <1142830+alexec@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Dec 2, 2025

@copilot Programming languages should always be lower case.

Reverted the language capitalization changes in docs/how-to/use-selectors.md and docs/reference/file-formats.md. Languages are now lowercase as intended. (25797a5)

@alexec alexec marked this pull request as ready for review December 2, 2025 05:38
@alexec alexec enabled auto-merge (squash) December 2, 2025 05:38
@alexec alexec merged commit 4d8728c into main Dec 2, 2025
1 check passed
@alexec alexec deleted the copilot/fix-documentation-errors branch December 2, 2025 05:38
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