Skip to content

Commit 4f7e983

Browse files
authored
[scheduler/docs] Add docs for the new scheduler module (#2113)
1 parent 515b701 commit 4f7e983

File tree

7 files changed

+1682
-111
lines changed

7 files changed

+1682
-111
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,6 @@ target/*
4141
# Agent files
4242
AGENTS.md
4343
CLAUDE.md
44+
45+
# Documentation navigation temporary file
46+
docs/nav_order_index.txt

docs/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -146,16 +146,16 @@ nav_order|file_path
146146

147147
Example:
148148
```
149-
1|/Users/rfigueiredo/github/OpenCue/docs/_docs/index.md
150-
2|/Users/rfigueiredo/github/OpenCue/docs/_docs/quick-starts/index.md
149+
1|./docs/_docs/index.md
150+
2|./docs/_docs/quick-starts/index.md
151151
```
152152

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

156156
**Usage:**
157157
```bash
158-
cd /Users/rfigueiredo/github/OpenCue/docs
158+
cd ./docs
159159
python3 extract_nav_orders.py
160160
```
161161

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

170170
**Usage:**
171171
```bash
172-
cd /Users/rfigueiredo/github/OpenCue/docs
172+
cd ./docs
173173

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

0 commit comments

Comments
 (0)