ods-android icon indicating copy to clipboard operation
ods-android copied to clipboard

Documentation updates for links and mandatory arguments

Open B3nz01d opened this issue 2 years ago • 0 comments

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 avatar Oct 26 '23 11:10 B3nz01d