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

Question #2

Open
thepian opened this issue Nov 4, 2015 · 1 comment
Open

Question #2

thepian opened this issue Nov 4, 2015 · 1 comment

Comments

@thepian
Copy link
Member

thepian commented Nov 4, 2015

I think this is a good approach if it is more of a story based introduction type thing. The nice thing is easy linking and the ability to fork it.

Did you consider the ability to treat the Wiki as a git REPO. We could have the wiki as a submodule to socket stream and a build step for deploying documentation on socket stream.org

The two could co-exist with the Wiki being a FAQ and this being more of a tutorial.

I think the djangoproject.org has a lot of good documentation approaches including the django book.

@arxpoetica
Copy link
Member

Yes and no. I think "tutorial" is the wrong word. Good documentation reads like a tutorial—and we've never had full on "spell it out" documentation of that kind. It probably won't suffice to try and explain it over GitHub. We should talk about this more direct if possible. You can DM if you want: https://twitter.com/arxpoetica and I can try and set something up.

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

No branches or pull requests

2 participants