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 guideline for the info.documentation URL to point to the API's repository #406

Open
tanjadegroot opened this issue Feb 5, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@tanjadegroot
Copy link
Contributor

Problem description
Today the URL in the info.documentation field is pointing to the overall CAMARA project.

Expected action
Update the info section in API design guidelines to specify that the URL should point to the API repository (which holds all documentation).

Can be done now or for Fall25 version.
it is recommended through the review for many APIs already.

@tanjadegroot tanjadegroot added the documentation Improvements or additions to documentation label Feb 5, 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

No branches or pull requests

1 participant