Wikifying the documentation

new topic     » topic index » view thread      » older message » newer message

Forked from Re: Help With Editing the Euphoria Documentation

euphoric said...

Once the new 4.1 docs are online, how do we wikify it?

The source content for the docs (in comments or in text files) are already in Creole format, so they're already (mostly) wiki-ready. There may be some massaging needed to make it fit but not much.

euphoric said...

And, again, how do we integrate future changes to the source in that online docs wiki?

In order to use the wiki for documentation, we need to move the source content from its current home to the wiki. We need to maintain a single source of truth. All of the content in docs/ should just be removed and the comments in all of the std/*.e files should be slimmed down to be comments, not documentation.

I think it's great that anyone will be able to edit the documentation, but I'm also worried that anyone could edit the documentation, so perhaps some gate-keeping may be required. We should probably implement namespaces in the wiki so we can separate "manual" pages and other "content" pages and allow for more fine-grained permissions via additional roles.

I also thing we should clean up the wiki in preparation to receive the docs. Unfortunately it suffers from the same state as the docs. There's a lot of duplicate and outdated content that needs to be reviewed and updated or discarded.


new topic     » topic index » view thread      » older message » newer message


Quick Links

User menu

Not signed in.

Misc Menu