Skip to content

Conversation

@Omega359
Copy link
Contributor

Which issue does this PR close?

Rationale for this change

direct links to config items

What changes are included in this PR?

docs

Are these changes tested?

I don't know of a way to preview the site so .. no? The generated markdown looks ok in my IDE preview.

Are there any user-facing changes?

Yes, doc updates

@github-actions github-actions bot added documentation Improvements or additions to documentation common Related to common crate execution Related to the execution crate labels Jan 31, 2026
@Omega359 Omega359 marked this pull request as ready for review January 31, 2026 18:47
@Jefffrey
Copy link
Contributor

Jefffrey commented Feb 1, 2026

I tried building this locally with the steps:

It's recommended to install build dependencies and build the documentation
inside a Python virtualenv.
```sh
python3 -m venv venv
pip install -r requirements.txt
```
If using [uv](https://docs.astral.sh/uv/) the script can be run like so without
needing to create a virtual environment:
```sh
uv run --with-requirements requirements.txt bash build.sh
```

They don't seem to be working when rendered as a site 🤔

image
  • Can't see anywhere to click for a anchor link

Though the HTML does show there is supposed to be something there

image

@Omega359
Copy link
Contributor Author

Omega359 commented Feb 1, 2026

I don't know how I missed that readme, thx for testing this. I'll convert back to draft till I have a fix.

@Omega359 Omega359 marked this pull request as draft February 1, 2026 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

common Related to common crate documentation Improvements or additions to documentation execution Related to the execution crate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add anchor links to individual config settings in Configuration Settings docs page

2 participants