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

Documentation updates for links and mandatory arguments #686

Open
B3nz01d opened this issue Oct 26, 2023 · 0 comments
Open

Documentation updates for links and mandatory arguments #686

B3nz01d opened this issue Oct 26, 2023 · 0 comments
Labels
📖 documentation Improvements or additions to documentation

Comments

@B3nz01d
Copy link
Collaborator

B3nz01d commented Oct 26, 2023

Requirements

Documentation linking

As a user of the documentation
I want to be able to copy an anchor to a dedicated paragraph of the page
So that I can send it to someone to share a dedicated specific content of an api structure, or code example

API cross linking references

As a user of the documentation
I want to be able to read an api documentation
So that I can click on the link of a sub class described in the table description of an api to access it's own details

Mandatory API Arguments

As a user of the documentation
I want to be able to view at a glance the structure of the api description
So that I can easily see all the mandatory argument the show in bold

Implementation

The anchor link can be shown with a "#" after the section tile

@B3nz01d B3nz01d added the 📖 documentation Improvements or additions to documentation label Oct 26, 2023
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
Development

No branches or pull requests

1 participant