Re: Help With Editing the Euphoria Documentation
- Posted by jimcbrown (admin) Sep 19, 2019
- 1415 views
I find myself in agreement with this approach.
Let regular users edit a live copy of the docs on the wiki (or elsewhere if that makes more sense ala Google Docs or similar).
The docs in the source code do need to be updated, but the eight step workflow could easily scare away non-developers. So it makes sense to have a lot of the "doc development" on the wiki, and have _tom grab the wiki changes and update the source code manually prior to a new release. _tom isn't afraid to take on the github workflow, but a newbie potential doc editor might be.
Anyone who wants to contribute anything more than a doc change (say someone wants to update one of the stdlib include files) will need to go through the github workflow, but at that point the person is no longer a doc editor but a full fledged developer - and thus should be familiar with this kind of git workflow.
As for which version is "official"? The docs in the source code remain official for any actual release made (since in the process of moving doc hanges into github they'll get reviewed etc) but the wiki has the "bleeding edge" version of the docs.
