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 links to documentation pages from the REST API page #508

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

PGijsbers
Copy link
Collaborator

@PGijsbers PGijsbers commented Apr 1, 2025

Change

Adds a link to the general documentation pages which provide more context and also usage examples.

How to Test

Visit the API docs, look at the text at the top of the page.
Note that the link is to the GitHub pages, it does not reflect local changes to the documentation.
I guess we could do this through a configuration variable, but that seems unnecessary to me since we are currently not hosting our own pages (instead we use GitHub pages). When that changes (e.g., also to support dev docs), we can update.

Checklist

  • Tests have been added or updated to reflect the changes, or their absence is explicitly explained.
  • Documentation has been added or updated to reflect the changes, or their absence is explicitly explained.
  • A self-review has been conducted checking:
    • No unintended changes have been committed.
    • The changes in isolation seem reasonable.
    • Anything that may be odd or unintuitive is provided with a GitHub comment explaining it (but consider if this should not be a code comment or in the documentation instead).
  • All CI checks pass before pinging a reviewer, or provide an explanation if they do not.

Related Issues

closes #452

@PGijsbers PGijsbers added the documentation Improvements or additions to documentation label Apr 1, 2025
@PGijsbers PGijsbers self-assigned this Apr 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add links to docs from generated docs
1 participant