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

Add more prominent link to rendered docs #628

Closed
ml-evs opened this issue Dec 14, 2020 · 0 comments · Fixed by #629
Closed

Add more prominent link to rendered docs #628

ml-evs opened this issue Dec 14, 2020 · 0 comments · Fixed by #629
Assignees
Labels
docs Issues pertaining to documentation. priority/medium Issue or PR with a consensus of medium priority

Comments

@ml-evs
Copy link
Member

ml-evs commented Dec 14, 2020

We have this section in our documentation (https://www.optimade.org/optimade-python-tools/configuration/#environment-variables) but perhaps it would be nice to link to it in the script itself, I agree the distinction between uvicorn flags/OPTIMADE options is a bit confusing.

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:

# Documentation 

Full documentation is available at the [optimade-python-tools website.](https://www.optimade.org/optimade-python-tools/)

(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)

@ml-evs ml-evs added docs Issues pertaining to documentation. priority/medium Issue or PR with a consensus of medium priority labels Dec 14, 2020
@ml-evs ml-evs self-assigned this Dec 14, 2020
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
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 <casper.andersen@epfl.ch>
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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant