#17063: Development Documentation Refactoring
----------------------------+----------------------------------
Reporter: kallisti5 | Owner: nielx
Type: enhancement | Status: new
Priority: normal | Milestone: Unscheduled
Component: Documentation | Version: R1/Development
Resolution: | Keywords: api pootle developer
Blocked By: | Blocking:
Platform: All |
----------------------------+----------------------------------
Description changed by kallisti5:
Old description:
We really should reformat our developer documentation.
* User Guide
* https://www.haiku-os.org/docs/userguide/en/contents.html
* Generated from docs/userguide in git
* Each language packed into haiku_userguide_XX hpkgs
* "User Guide" Icon installed on desktop
* Developer Guide
* https://www.haiku-os.org/docs/api/
* Generated from docs/user in git
* URL "api"
* Called "Haiku Book" (aka like BeBook)
* Not packaged, only on www.haiku-os.org.
Ideally, I think we should make the following changes:
1) Move code to docs/developerguide
2) Package like userguide (haiku_developerguide*.hpkg)
3) Add an icon to the desktop "Developer Guide"
4) Move document to haiku-os.org/docs/developerguide (and make
/docs/api a redirect)
I honestly didn't even know where the developerguide lived given the odd
/ inconsistent naming within our sources.
