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

Add Online Documentation #107

Open
nickclark2016 opened this issue Feb 5, 2022 · 2 comments
Open

Add Online Documentation #107

nickclark2016 opened this issue Feb 5, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@nickclark2016
Copy link
Contributor

When using this, it may be useful to add some documentation and then use a docgen tool (doxygen maybe?) to create docs. It'd be nice to have docs set up to be hosted from github pages so I can easily view the docs without relying on an IDE to preview it.

@charles-lunarg charles-lunarg added the documentation Improvements or additions to documentation label Apr 26, 2022
@charles-lunarg
Copy link
Owner

I'm adding the information from the other issue about creating more docs, rather than having two separate issues for the same thing.

  • A general overview of the different components.
  • A list of various problems and their vk-bootstrap API solutions.
  • Document the inner workings of the API
    • Which data is passed between the components
    • Automatically enabled extensions
    • Design rational of assumptions & choices

@charles-lunarg
Copy link
Owner

Well I enabled github.io pages and it uses the Readme.md. But i'll have to figure out a code documentation tool as well as write a longer/better guide to using the library.

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

2 participants