Opened 11 years ago

Closed 5 years ago

#2725 closed enhancement (fixed)

Website, some essential docs are hard to find for newcomers

Reported by: aldeck Owned by: aldeck
Priority: normal Milestone: R1
Component: Website Version:
Keywords: Cc: umccullough@…
Blocked By: Blocking:
Has a Patch: no Platform: All

Description

I'm seeing a lot of recurrent questions on IRC, forums and ml. I sometimes even have a hard time finding essential docs myself.

What we could do is rethink a bit the main page, i think we could add a "Testing" section that would contain useful links that don't really belong to the "Development" section (which is more a "Develop Haiku" section really).

"Testing" could contain links to:

  • Prebuilt images (define what are the images exactly, had this question on IRC)
  • Building from source + Build system FAQ (todo)
  • Testing on a virtual machine -> usage for qemu, vmware, vbox etc..
  • Testing on real hardware -> How To Boot Haiku (mmlr)
  • Getting help
  • Reporting bugs

Next would be to add a "Use Haiku" section, with links to basic use, particularities, tips, developing apps on haiku

Could be discussed on the ml though...

Change History (8)

comment:1 Changed 11 years ago by emitrax

I totally agree with the fact that documentation is not well organized. I do too have some hard time finding essential doc.

IMHO, the main page should have only a simple link: "Documentation" Then this page should be diveded in Developers - Users.

In the developer section you would put all the links, divided by topics, to all the articles. Same in the user sections, more or less like we do here http://www.haiku-os.it/documentazione

Anyway, this is just an idea. But definitely the current status needs to be changed.

comment:2 Changed 10 years ago by aldeck

Shameless bump! What about setting this to milestone R1/alpha1 ?

comment:3 Changed 10 years ago by umccullough

Cc: umccullough@… added

I'd also like to see this improved...

If someone will help me distill the content a bit, I'd like to refresh the guides into a single set of clear guides that are immediately easy to find.

My biggest problem is lack of focused time.

comment:4 Changed 10 years ago by iFrodo

@umccullough

I'm volunteer to help you on that task if you like...

comment:5 Changed 10 years ago by nielx

Good. I'm currently experimenting with a new infrastructure for docs. iFrodo, I suggest you drop a line on the haiku-web mailing list, I'm almost done with the preliminary work, so I will give you both some pointers there.

comment:6 Changed 9 years ago by nielx

Version: R1/pre-alpha1

Website tickets don't have a version.

comment:7 Changed 9 years ago by aldeck

Owner: changed from haiku-web to aldeck
Status: newassigned

comment:8 Changed 5 years ago by luroh

Resolution: fixed
Status: in-progressclosed

Documentation has been rearranged, improved and now covers most of the topics listed here, I feel it's safe to close this particular ticket.

Note: See TracTickets for help on using tickets.