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

Make API docs more useful for basic users #232

Open
jwallwork23 opened this issue Jan 13, 2025 · 0 comments
Open

Make API docs more useful for basic users #232

jwallwork23 opened this issue Jan 13, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@jwallwork23
Copy link
Contributor

One observation (that is not to be resolved here) is that our online API docs are no longer very useful for basic users and are instead geared at developers.
In reality, all basic users want is the Interface docs, and the list they get above is somewhat daunting. There is an option to lost interfaces here but I don't feel it helps. I'm not sure if there is an easy solution to this and should perhaps create a new issue.

Originally posted by @jatkinson1000 in #225 (review)

@jwallwork23 jwallwork23 added the documentation Improvements or additions to documentation label Jan 13, 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