@Araq, can the search be optional? For example, I don't need it here:
[http://vegansk.github.io/nimboost/docs/0.3.0/boost/data/rbtreem.html](http://forum.nim-lang.org///vegansk.github.io/nimboost/docs/0.3.0/boost/data/rbtreem.html)
Thanks for the update Araq!
For the upcoming 0.15.0 I have generated documentation here (still subject to
change and yes I know the version says 0.14.3):
[http://nim-lang.org/0.15.0/lib.html](http://forum.nim-lang.org///nim-lang.org/0.15.0/lib.html)
Issue created for the edit button:
[https://github.com/nim-lang/Nim/issues/4736](https://github.com/nim-lang/Nim/issues/4736)
+1 For the edit button idea à la ensime.org.
The "Edit" button idea is actually **very** nice. I often see issues in
documentation, but am too lazy to go to terminal, cd Nim, create branch, make
change, push branch, create PR (or do the same from GitHub UI) for a small
change. If there is a button on each page that goes straight to
If you look on how [ensime.org](http://forum.nim-lang.org///ensime.github.io/)
did the editing, it is just a button to do a fork and pull request on github,
with the github internal editor. This shouldn't bee to hard to implement, as
long as the site is not documentation embedded in nim code. I
I agree, we need to do a better job of getting feedback from the readers of our
documentation. I bet we could create a simple web service for that.
Easily editing documentation is more difficult, but something which would be
nice too. We can definitely improve our documentation a lot.
I think the documentation could improve a lot, if it is easier for the
community to contribute to it. For example in ensime.org, every page has an
edit button. This really simplifies the process for users to add something to
the documentation as they read it. Additionally to that it would also
@OderWat Any updates on this?
I've noticed that the docgen tool has very limited support of field lists. It
would be good to be able to add parameter descriptions via field list fields
but at the moment this doesn't seem to work.
Also if there was support for multiline comments for
I don't want to announce a time frame right now, because I also have a day job
:)
The idea is pretty simple: We collect all the docs from all the modules which
are in nimble automatically and add the docs of the compiler and the manual
itself.
Those get indexed by the Nim compilers own
@OderWat Have you any information on the creation of the better documentation?
I was planning a documentation site like php.net for nim.
I like the idea of external but integrated example files. Dropping a 50+ line
block right into the code base never seemed like the right idea.
Well. It could be as simple as creating PR where multiple people working in
collaboration to add to the documentation. There is no need to extract them
from the sources and re-inject them again.
For some key modules there also could be some example.rst files which get
included with the module
I don't know about StackOverflow Documentation, but the GitHub wiki allows
exporting pages. We could use it for collaborative editing and then extract
good pages and merge them into the mainline doc at release time.
It looks interesting but i reserve some doubt about having a 3th party hosting
the documentation. And it also raises questions about synchronizing the
documentation in the code with stackoverflow...
@wulfklaue: I don't believe the intention is to replace the standard docs, but
the StackOverflow docs would instead be more concentrated around providing
examples, which I personally am all for.
Based on some of the previous comments/concerns over Nim documentation, this
seems like it might address some of the issues:
[http://stackoverflow.com/documentation/nim/commit](http://forum.nim-lang.org///stackoverflow.com/documentation/nim/commit)
Upvote if you're interested.
18 matches
Mail list logo
