Skip to content
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

Use edit_uri correctly in mkdocs.yml #52

Open
DiscoStarslayer opened this issue Oct 4, 2019 · 0 comments
Open

Use edit_uri correctly in mkdocs.yml #52

DiscoStarslayer opened this issue Oct 4, 2019 · 0 comments
Labels
infrastructure Issues which affect the website itself (style / reachability).

Comments

@DiscoStarslayer
Copy link
Contributor

According to the documentation we are not correctly using edit_uri. Currently we set this config to a full path (https://github.com/xqemu/xqemu.com/blob/master/docs/) because our docs live in a separate repo from the project we are documenting (https://github.com/xqemu/xqemu/).

This is incorrect, as edit_uri is only meant to be a path that is appended to the repo_url, not a separate route entirely. Our current use of this property is not expected by the documentation and may break in the future.

We should ideally fix this problem, depending on the end result of #41.

No GitHub link on top-right of the page:

Keep GitHub link on the top-right of the page:

@JayFoxRox JayFoxRox added the infrastructure Issues which affect the website itself (style / reachability). label Oct 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infrastructure Issues which affect the website itself (style / reachability).
Projects
None yet
Development

No branches or pull requests

2 participants