Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Application to be self documenting #13

Open
grahambrooks opened this issue May 4, 2011 · 0 comments
Open

Application to be self documenting #13

grahambrooks opened this issue May 4, 2011 · 0 comments
Labels

Comments

@grahambrooks
Copy link
Contributor

As a user I want user level documentation as part of the application so that I can read the documentation without requiring an internet connection.

Implementation Notes

Consider using github/gollum as a basis for a documentation wiki. This could replicate from GitHub and then each instance could push back their changes onto a unique branch. The branches could then be merged back into trunk etc. Not thought through the details but at first glance this looks attractive.

Acceptance criteria

Given I am viewing any page when I click the 'help' link I am directed to the user documentation within the current site.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant