Opened 3 years ago
Last modified 3 years ago
#17063 new enhancement
Development Documentation Refactoring — at Version 1
| Reported by: | kallisti5 | Owned by: | nielx |
|---|---|---|---|
| Priority: | normal | Milestone: | Unscheduled |
| Component: | Documentation | Version: | R1/Development |
| Keywords: | api pootle developer | Cc: | |
| Blocked By: | Blocking: | ||
| Platform: | All |
Description (last modified by )
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.
Note:
See TracTickets
for help on using tickets.
