New user documentation in markdown #292

Merged
merged 24 commits into from Apr 11, 2016

Conversation

Projects
None yet
3 participants
@steffengraber
Contributor

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.

@heplesser

heplesser Apr 5, 2016

Contributor

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

@heplesser

heplesser Apr 5, 2016

Contributor

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

This comment has been minimized.

@steffengraber

steffengraber Apr 5, 2016

Contributor

Only an artefact. I have deleted 'prettyprint'.

@steffengraber

steffengraber Apr 5, 2016

Contributor

Only an artefact. I have deleted 'prettyprint'.

@heplesser

This comment has been minimized.

Show comment
Hide comment
@heplesser

heplesser Apr 5, 2016

Contributor

@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.

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

This comment has been minimized.

Show comment
Hide comment
@jougs

jougs Apr 5, 2016

Contributor

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.

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

This comment has been minimized.

Show comment
Hide comment
@jougs

jougs Apr 5, 2016

Contributor

@steffengraber: very nice work, btw!

Contributor

jougs commented Apr 5, 2016

@steffengraber: very nice work, btw!

@heplesser

This comment has been minimized.

Show comment
Hide comment
@heplesser

heplesser Apr 11, 2016

Contributor

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?

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

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