Ask Your Question

Suggestion: Make community edited wiki

asked 2012-03-03 13:00:21 -0600

powlo's avatar

It would be good if the Askbot docs were presented as a wiki so developers could put notes against paragraphs and so on. I think Django uses something like this on their docs pages. It could be hidden from view by default to prevent viewers being hit by a barrage of comment tags.

There are several typos, style changes and more important missing functionality documentation that I'd like to put in. Askbot needs a mechanism to manage these submissions.

It looks like the documentation shown on this site comes from the git controlled source so I could just make changes and then do a git pull request. However this mechanism would lack any discussion around a documentation issue and those only interested in deploying and not coding might be locked out.

edit retag flag offensive close merge delete

1 Answer

Sort by ยป oldest newest most voted

answered 2012-03-03 16:26:40 -0600

Evgeny's avatar

The reason for this is that it will be very hard to guarantee consistency of the documentation with the code when the documentation is not in the source control system. So unfortunately this cannot be done.

However - askbot is hosted on github - so anyone can make a fork and edit documentation directly on github, then make a pull request.

edit flag offensive delete link more

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account.

Add Answer

Question Tools


Asked: 2012-03-03 13:00:21 -0600

Seen: 279 times

Last updated: Mar 03 '12