Re: Roadmap to Euphoria 4.2
- Posted by ghaberek (admin) Sep 05, 2019
- 1245 views
Not being able to edit online docs has been a mystery for a long time. I understood, from a long time ago, that I could not edit them or easily download updates--result is they have been ignored.
At the moment I have started to make a clone of the std/lib docs in the wiki; problem is I have to cut and paste each page and progress is very slow.
Direct editing of the online docs would solve a lot of problems!
It seems I've been unclear in my request for assistance in auditing the documentation.
To be clear: 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:
- Check out the Euphoria source code from GitHub.*
- 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 back to GitHub.*
* Ideally you should create a fork, push your changes there, and then create a pull request.
-Greg
Forked into: Help With Editing the Euphoria Documentation
