Help With Editing the Euphoria Documentation
- Posted by euphoric (admin) Sep 06, 2019
- 1750 views
Forked from Re: Roadmap to Euphoria 4.2
I wanted to put this (slightly modified) in its own thread so I don't keep losing it, and so people know how to help:
ghaberek said...
The documentation is generated from the code in include/std and the text files in docs/ (refman_2.txt, etc.). The only way to update the docs is to edit these files.
Here is the approximate workflow you'll need:
- Create a fork of the Euphoria source code
- Generate the HTML docs using eudoc and creole.
- Open the HTML docs in your browser and review.
- Make your corrections to the source or text files.
- Commit your changes to your local git repo.
- Repeat steps 2-5 until you're done.
- Push your commits to your GitHub repo.
- Create a pull request.