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

New user documentation in markdown #292

Merged
merged 24 commits into from Apr 11, 2016
Merged

Conversation

@steffengraber
Copy link
Collaborator

steffengraber commented Apr 5, 2016

These are the static pages of user documentation. In the future, they will serve as a basis of the creation of the website and the documentation in the source code.

From now on changes in the documentation and adding new texts can be done here and editing of documents is as easy as creating code.


As an example, here is the multimeter.py example from the PyNEST examples set:

prettyprint

This comment has been minimized.

Copy link
@heplesser

heplesser Apr 5, 2016

Contributor

Why does prettyprint have an extra space in front of it?

This comment has been minimized.

Copy link
@steffengraber

steffengraber Apr 5, 2016

Author Collaborator

Only an artefact. I have deleted 'prettyprint'.

@heplesser
Copy link
Contributor

heplesser commented Apr 5, 2016

@steffengraber I think this is very nice! I would propose to merge this rather quickly without detailed review of the content, since it is the same material that is on our website today. We can then rather open issues for fixing specific problems.

@jougs
Copy link
Contributor

jougs commented Apr 5, 2016

I agree with @heplesser that we should merge this immediately in order to get the whole infrastructure in place and allow people to contribute to the homepage via GitHub. I'll thus merge once the tests have completed.

@jougs
Copy link
Contributor

jougs commented Apr 5, 2016

@steffengraber: very nice work, btw!

@steffengraber steffengraber force-pushed the steffengraber:static-markdown-doc branch from cd6fed9 to 61dd0b1 Apr 8, 2016
@heplesser
Copy link
Contributor

heplesser commented Apr 11, 2016

I will merge this now, we can then iterate in the repo.

@steffengraber Could you send a mail to our mailing lists explaining the purpose of the usedoc in the repo? Maybe we should also add some guidelines/info on the Developerspace web pages?

@heplesser heplesser merged commit fdfed89 into nest:master Apr 11, 2016
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@steffengraber steffengraber deleted the steffengraber:static-markdown-doc branch Nov 29, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
You can’t perform that action at this time.