Skip to content

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

Open

Description

@aufdenkampe

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

Activity

  1. added a commit that references this issue on Apr 10, 2024
    014a5a6
  2. aufdenkampe commented on Apr 10, 2024

    @aufdenkampe
    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.

  3. changed the title [-]Add link to docs in the About section[/-] [+]Add link to docs in the About section and README[/+] on Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions