Skip to content

Commit

Permalink
docs on editing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
RandyGaul committed Jun 15, 2024
1 parent 35dd9bd commit 0d6399f
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,3 +132,9 @@ If your sample needs access to files on disk, such as assets like images or audi
And that's it! Regenerate your project and you will be able to build your new sample. The next step is to add in your sample to [CF's documentation](https://randygaul.github.io/cute_framework/#/samples). You should [edit this file](https://github.com/RandyGaul/cute_framework/blob/master/docs/samples.md) to add your sample to the list of CF samples.

Once confirmed working as intended, open a pull request to add in your new sample!

# Editing the Docs

All of CF's docs for the [CF website](https://randygaul.github.io/cute_framework/#/) are located here in GitHub [under the docs folder](https://github.com/RandyGaul/cute_framework/tree/master/docs). Editing any of these docs is a good way to contribute to CF through a pull-request.

Please note that the reference pages for functions/structs are automatically generated by CF's [docs parser + generator](https://github.com/RandyGaul/cute_framework/blob/master/samples/docs_parser.cpp). You can run this executable to regenerate all of the docs files for all of CF. If you wish to edit any of the reference pages be sure to edit the appropriate file in CF's actual source code and regenerate the docs by running the CF sample [docs_parser](https://github.com/RandyGaul/cute_framework/blob/master/samples/docs_parser.cpp). You can then create a pull-request for any of the regenerated docs files.

0 comments on commit 0d6399f

Please sign in to comment.