Skip to content

Fix documentation inconsistencies and errors #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexec merged 4 commits into from
Dec 2, 2025
Merged

Fix documentation inconsistencies and errors #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8bc08eb
Initial plan
Copilot Dec 2, 2025
afe28dc
Fix documentation issues: update file structure, theme references, fi…
Copilot Dec 2, 2025
25797a5
Revert language capitalization changes per feedback - keep languages …
Copilot Dec 2, 2025
6d54ccf
Merge branch 'main' into copilot/fix-documentation-errors
alexec Dec 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,11 @@ The documentation is available at: **https://kitproj.github.io/coding-context-cl
## Structure

- `index.md` - Home page with overview and quick start
- `getting-started.md` - Installation and first steps guide
- `usage.md` - Detailed CLI reference and usage guide
- `agentic-workflows.md` - Integration with GitHub Actions
- `examples.md` - Real-world examples and templates
- `tutorials/` - Step-by-step learning guides
- `how-to/` - Problem-oriented practical guides
- `reference/` - Technical specifications
- `explanation/` - Conceptual documentation
- `_config.yml` - Jekyll configuration
- `_layouts/default.html` - Custom layout with navigation

## Building Locally

Expand All @@ -28,7 +27,7 @@ gem install bundler jekyll
cat > Gemfile << 'EOF'
source 'https://rubygems.org'
gem 'github-pages', group: :jekyll_plugins
gem 'jekyll-theme-cayman'
gem 'just-the-docs'
EOF

# Install dependencies
Expand All @@ -46,7 +45,7 @@ The site is automatically deployed to GitHub Pages when changes are pushed to th

## Theme

The site uses the Cayman theme, which is one of the officially supported GitHub Pages themes. The theme is configured in `_config.yml`.
The site uses the Just the Docs theme, which provides excellent navigation and search capabilities. The theme is configured in `_config.yml`.

## Updating Documentation

Expand All @@ -57,4 +56,4 @@ The site uses the Cayman theme, which is one of the officially supported GitHub

## Navigation

The site navigation is defined in the custom layout file `_layouts/default.html`. To modify the navigation structure, edit that file.
The site uses the Just the Docs theme, which automatically generates navigation from frontmatter in each page (using `nav_order`, `parent`, and `has_children` fields).
1 change: 0 additions & 1 deletion docs/reference/search-paths.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ coding-context code-review → Uses ~/.agents/tasks/code-review.md (from ho
```

**Note:** The working directory and home directory are automatically added to search paths, so tasks in those locations are found automatically.
```

## Rule File Search Paths

Expand Down