Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Point to the documentation from the top of the README #661

Merged
merged 2 commits into from
Sep 5, 2024

Conversation

tmadlener
Copy link
Collaborator

BEGINRELEASENOTES

  • Make the README point to the documentation instead of the markdown files

ENDRELEASENOTES

@m-fila should I keep the links to the markdown files? Or are you happy with where the link takes you?

Copy link
Contributor

@m-fila m-fila left a comment

Choose a reason for hiding this comment

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

Thank you Thomas. I remembered you set-up a nice documentation with sphinx, but I couldn't find a link to it, hence my request. I think it's very visible now.
The links to markdown can go I think

For extra swag and visual presence we might also slap a badge 😉
docs

@tmadlener
Copy link
Collaborator Author

Swag is always good ;) Thanks for the pointer.

@tmadlener tmadlener merged commit 98a786a into master Sep 5, 2024
17 of 18 checks passed
@tmadlener tmadlener deleted the doc-to-readme branch September 5, 2024 17:58
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants