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

Consider creating an overall Overview section #75

Open
jerstlouis opened this issue Nov 23, 2024 · 0 comments
Open

Consider creating an overall Overview section #75

jerstlouis opened this issue Nov 23, 2024 · 0 comments
Assignees

Comments

@jerstlouis
Copy link
Member

Currently, the draft has overview for each requirement class but not much in terms of an overall introduction.

We could include in there the table of resources and parameters proposed by João, inform the user of where to find the OpenAPI resources, and mention the Examples annex and that developers might want to start reading the annex before diving into the detailed requirements of each requirements class.

This should help making the standard easier to digest by developers.

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

No branches or pull requests

1 participant