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 link to docs in the About section and README #98

Open
aufdenkampe opened this issue Apr 10, 2024 · 1 comment · May be fixed by #100
Open

Add link to docs in the About section and README #98

aufdenkampe opened this issue Apr 10, 2024 · 1 comment · May be fixed by #100

Comments

@aufdenkampe
Copy link

aufdenkampe commented Apr 10, 2024

To easily get from the repo to the docs at https://babelizer.readthedocs.io, it would be helpful to add the url to the rendered docs to the About section under the repo Description (i.e. upper right pane of repo's landing page, editable via the gears icon).

mdpiper added a commit that referenced this issue Apr 10, 2024
@aufdenkampe
Copy link
Author

The main ReadMe also has no links to the User Guide at the root of the docs, so if I navigate to https://babelizer.readthedocs.io/en/latest/readme.html I have no easy way to navigate back.

This can be quite confusing, as the README.rst and index.rst look very similar. It would be helpful to better differentiate the two and have a prominent link to the User Guide (i.e. index.rst) at the top of the ReadMe.

@aufdenkampe aufdenkampe changed the title Add link to docs in the About section Add link to docs in the About section and README Apr 10, 2024
@mdpiper mdpiper linked a pull request Apr 12, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant