-
Notifications
You must be signed in to change notification settings - Fork 44
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
Add more prominent link to rendered docs #628
Labels
docs
Issues pertaining to documentation.
priority/medium
Issue or PR with a consensus of medium priority
Comments
ml-evs
added a commit
that referenced
this issue
Dec 14, 2020
- Removed dependabot badge as its currently broken for everyone - Reworked some sections of README (closes #628) - Added contributors badge - Added OPTIMADE logo - Fixed some formatting - Moved INSTALL.md to top-level and unified links
ml-evs
added a commit
that referenced
this issue
Dec 14, 2020
- Removed dependabot badge as its currently broken for everyone - Reworked some sections of README (closes #628) - Added contributors badge - Added OPTIMADE logo - Fixed some formatting - Moved INSTALL.md and CHANGELOG.md to top-level and unified links
6 tasks
ml-evs
added a commit
that referenced
this issue
Dec 16, 2020
- Removed dependabot badge as its currently broken for everyone - Reworked some sections of README (closes #628) - Added contributors badge - Added OPTIMADE logo - Fixed some formatting - Moved INSTALL.md and CHANGELOG.md to top-level and unified links
ml-evs
added a commit
that referenced
this issue
Dec 17, 2020
- Removed dependabot badge as its currently broken for everyone - Reworked some sections of README (closes #628) - Added contributors badge - Added OPTIMADE logo - Fixed some formatting - Moved INSTALL.md and CHANGELOG.md to top-level and unified links - Use https for git clone example
ml-evs
added a commit
that referenced
this issue
Dec 17, 2020
- Removed dependabot badge as its currently broken for everyone - Reworked some sections of README (closes #628) - Added contributors badge - Added OPTIMADE logo - Fixed some formatting - Moved INSTALL.md and CHANGELOG.md to top-level and unified links - Use https for git clone example
ml-evs
added a commit
that referenced
this issue
Dec 17, 2020
- Removed dependabot badge as its currently broken for everyone - Reworked some sections of README (closes #628) - Added contributors badge - Added OPTIMADE logo - Fixed some formatting - Moved INSTALL.md and CHANGELOG.md to top-level and unified links - Use https for git clone example
CasperWA
added a commit
that referenced
this issue
Dec 21, 2020
* Updated README and top-level docs: - Removed dependabot badge as its currently broken for everyone - Reworked some sections of README (closes #628) - Added contributors badge - Added OPTIMADE logo - Fixed some formatting - Moved INSTALL.md and CHANGELOG.md to top-level and unified links - Use https for git clone example * Update Publish workflow with CHANGELOG path change Co-authored-by: Casper Welzel Andersen <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
docs
Issues pertaining to documentation.
priority/medium
Issue or PR with a consensus of medium priority
Ah, thanks, I had indeed missed this. In fact, I had missed that there was a pre-rendered version of the full docs at https://www.optimade.org/optimade-python-tools/, (but I see I could have picked up the configuration info from reading `docs/configuration.md".)
Perhaps in the overhaul of the docs once could consider a slightly more prominent link to https://www.optimade.org/optimade-python-tools/ in the README.md to help direct those who glances over it, e.g. as:
(But I see how this link gets a bit weird if you want the first page of the website to be rendered from the README.md, hmm...)
Originally posted by @rartino in #627 (comment)
The text was updated successfully, but these errors were encountered: