[haiku-development] Re: JSON Streaming Parser (Part 2)
- From: "Adrien Destugues" <pulkomandy@xxxxxxxxxxxxx>
- To: haiku-development@xxxxxxxxxxxxx
- Date: Fri, 12 May 2017 06:47:57 +0000
12 mai 2017 08:36 "Andrew Lindesay" <apl@xxxxxxxxxxxxxx> a écrit:
I have also written some documentation in the form of a Markdown file in
the "/docs/...". I see there is all sorts of documentation in there.
Is that the best way to do this?
docs/user is used to generate the Haiku Book at
http://api.haiku-os.org. It ;
should have all the API documentations from a user perspective (user in the
sense of someone writing an application for Haiku).
docs/develop is for internal documentation, addressed to Haiku developers. The
directory hierarchy roughly mirrors src/kits, but there are exceptions. There
is no rule on which tools and format to use for now: if you want to write some
documentation, no style guidelines or tool requirement should get in your way ;)
--
Adrien.
Other related posts:
