Skip to content

doc: use absolute links in style guide, add link to cookiecutter #5656

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

petrasovaa
Copy link
Contributor

Relative links to files in repo don't work anymore now when style guide is part of documentation.

Also adds a link to the addon template in development documentation.

Copy link
Member

@echoix echoix left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't it be properly configured on the tool used side? It seems like a regression for us to have this PR

@github-actions github-actions bot added docs markdown Related to markdown, markdown files labels May 15, 2025
@echoix
Copy link
Member

echoix commented May 21, 2025

To see if setting docs_dir to a relative path like "../../" (appropriate for the location of the root of the repo with respect to the config file location).

https://www.mkdocs.org/user-guide/configuration/#docs_dir

Also consider if there's blockers to have the mkdocs.yml config file at the root, to be able to build with "mkdocs build" without changing any directories first.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs markdown Related to markdown, markdown files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants