Skip to content

[scheduler/docs] Add docs for the new scheduler module #2113

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
DiegoTavares merged 4 commits into from
Dec 17, 2025
Merged

[scheduler/docs] Add docs for the new scheduler module #2113

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
2eca882
[scheduler/docs] Add docs for the new scheduler module
DiegoTavares Dec 12, 2025
3e8c6f0
Update navigation order
DiegoTavares Dec 16, 2025
d64340f
Clean documentation setup
DiegoTavares Dec 16, 2025
273904c
Apply review changes
DiegoTavares Dec 16, 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
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,6 @@ target/*
# Agent files
AGENTS.md
CLAUDE.md

# Documentation navigation temporary file
docs/nav_order_index.txt
10 changes: 5 additions & 5 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,16 +146,16 @@ nav_order|file_path

Example:
```
1|/Users/rfigueiredo/github/OpenCue/docs/_docs/index.md
2|/Users/rfigueiredo/github/OpenCue/docs/_docs/quick-starts/index.md
1|./docs/_docs/index.md
2|./docs/_docs/quick-starts/index.md
```

#### `extract_nav_orders.py`
Script to extract `nav_order` values from all markdown files in the `_docs` directory and save them to `nav_order_index.txt`.

**Usage:**
```bash
cd /Users/rfigueiredo/github/OpenCue/docs
cd ./docs
python3 extract_nav_orders.py
```

Expand All @@ -169,7 +169,7 @@ Script to update `nav_order` values in markdown files based on the values in `na

**Usage:**
```bash
cd /Users/rfigueiredo/github/OpenCue/docs
cd ./docs

# Dry run - see what would change without modifying files
python3 update_nav_order.py --dry-run
Expand Down Expand Up @@ -479,4 +479,4 @@ bundle install
1. Check existing [GitHub Issues](https://github.com/AcademySoftwareFoundation/OpenCue/issues)
2. Run `./build.sh` for diagnostic information
3. Join the [OpenCue Slack](https://academysoftwarefdn.slack.com/archives/CMFPXV39Q) for community support
4. Create detailed issue with error logs and steps to reproduce
4. Create detailed issue with error logs and steps to reproduce
Loading
Loading