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.

Sign up for GitHub

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

Jump to bottom

Add start page to API documentation #616

Closed
kyllingstad opened this issue Oct 6, 2020 · 0 comments · Fixed by #617
Closed

Add start page to API documentation #616

kyllingstad opened this issue Oct 6, 2020 · 0 comments · Fixed by #617
Assignees
@kyllingstad
Labels
enhancement New feature or request

Comments

@kyllingstad
Copy link
Member

Every time I need to look up something in the libcosim API documentation, I have to go via the namespace/class/file lists generated by Doxygen. All of these have become rather large, and sifting through them takes time. It would be great to have a start page that allows one to find things more quickly.

While our API consists of a large number of classes and functions, some of them are more central than others. Examples include execution, system_structure, slave, observer and so on. These could serve as starting points for exploring the API, as their documentation links to that of other, less central entities that mainly serve as support structure.

This would also make the documentation more accessible to newcomers, who have no idea of where to start.
@kyllingstad kyllingstad added the enhancement New feature or request label Oct 6, 2020
@kyllingstad kyllingstad self-assigned this Oct 6, 2020
kyllingstad added a commit that referenced this issue Oct 6, 2020
@kyllingstad
Add an introductory page to the API documentation
16d2028 
The contents of `docs/main_page.md` will be the first thing the user
sees upon browsing the API documentation.

This fixes #616.
@kyllingstad kyllingstad mentioned this issue Oct 6, 2020
Merged
kyllingstad added a commit that referenced this issue Oct 9, 2020
@kyllingstad
Add an introductory page to the API documentation (#617)
5e1750a 
The contents of `docs/main_page.md` will be the first thing the user
sees upon browsing the API documentation.

This fixes #616.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kyllingstad kyllingstad

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add an introductory page to the API documentation open-simulation-platform/libcosim
1 participant
@kyllingstad