xref: /haiku/docs/develop/index.rst (revision 3d4afef9cba2f328e238089d4609d00d4b1524f3)
1Welcome to Haiku internals's documentation!
2===========================================
3
4
5Target audience
6---------------
7
8This documentation is aimed at people who want to contribute to Haiku by modifying the operating
9system itself. It covers various topics, both technical (how things work) and organizational
10(patch submission process, for example).
11
12This document might also be useful to application developers trying to understand the behavior of
13the operating system in some specific cases, however, the `API documentation <https://api.haiku-os.org>`_ should answer most of
14the questions in this area already.
15
16This documentation assumes basic knowledge of C++ and the Be API, if you need more information
17about that, please see the `Learning to program with Haiku <https://github.com/theclue/programming-with-haiku/releases/tag/v1.1>`_ book.
18
19Status of this document
20-----------------------
21
22The work on this book has just started, many sections are incomplete or missing. Here is a list of
23other resources that could be useful:
24
25* The `Haiku website <https://www.haiku-os.org>`_ has several years of blog posts and articles
26  documenting many aspects of the system,
27* The `Coding guidelines <https://www.haiku-os.org/development/coding-guidelines/>`_ describes how code should be formatted,
28* The `User guide <https://www.haiku-os.org/docs/userguide/en/contents.html>`_ documents Haiku from the users' point of view and can be useful to understand how things are supposed to work,
29* The `Haiku Interface Guidelines <https://www.haiku-os.org/docs/HIG/index.xml>`_ document graphical user interface conventions,
30* The `Haiku Icon Guidelines <https://www.haiku-os.org/development/icon-guidelines>`_ gives some rules for making icons fitting with the style of the existing ones.
31
32Table of contents
33-----------------
34
35* :ref:`search`
36
37.. toctree::
38   :maxdepth: 2
39   :caption: Contents:
40
41   /build/repositories/README
42   /apps/haikudepot/server
43   /midi/index
44   /net/NetworkStackOverview
45   /net/HowTo-Synchronize_with_NetBSD
46   /packages/README
47   /servers/app_server/toc
48   /servers/registrar/Protocols
49   /kernel/device_manager_introduction
50   /kernel/obsolete_pnp_manager
51   /kernel/vm/swap_file_support
52   /kernel/arch/long_double
53   /kernel/arch/arm/overview
54   /kernel/arch/m68k/overview
55   /kernel/arch/ppc/overview
56   /kernel/arch/sparc/overview
57   /kernel/fs/node_monitoring
58   /file_systems/overview
59   /partitioning_systems/sun
60   /drivers/disk/ioctls
61   /drivers/intel_extreme/generations
62   /busses/agp_gart/ReadMe
63   /busses/bluetooth/overview
64   /busses/sdhci/sdhci_mmc_driver
65   /busses/usb/USB_stack_design
66   /kernel/boot/boot_process_specs.rst
67   /kernel/boot/Debugging_Bootloaders_GEF
68   /kernel/pci_serial_debug
69
70