diff options
| -rw-r--r-- | docs/6_Component_Documentation/8_ic-sound-manager.md | 8 | ||||
| -rw-r--r-- | docs/7_How_To_Contribute/8_Adding_Documentation.md | 18 |
2 files changed, 18 insertions, 8 deletions
diff --git a/docs/6_Component_Documentation/8_ic-sound-manager.md b/docs/6_Component_Documentation/8_ic-sound-manager.md index 75e163e..e1c22f4 100644 --- a/docs/6_Component_Documentation/8_ic-sound-manager.md +++ b/docs/6_Component_Documentation/8_ic-sound-manager.md @@ -37,10 +37,10 @@ not need to be aware of the exact applications that are running on this containe - All the containers, including the host, are running a variant of AGL -- The host OS and the secondary domain container use PipeWire and WirePlumber +- The host OS and the secondary domain container use PipeWire and WirePlumber to implement the sound system -- The sound hardware offers, on the Linux kernel driver side, a separate ALSA +- The sound hardware offers, on the Linux kernel driver side, a separate ALSA device for sounds that belong to the IC and a separate ALSA device for other sounds ## Architectural design @@ -70,7 +70,7 @@ them the ability to pause or resume sounds that are being routed via PipeWire. Finally, IC applications are given a library (icipc library) that allows them to send messages to pipewire-ic-ipc on the host. This library is minimal and has no external dependencies, -for safety reasons. +for safety reasons. For sound playback, IC applications are expected to use the ALSA API directly and communicate with the dedicated ALSA device that is meant for IC sounds. Arbitration of this device between @@ -101,7 +101,7 @@ pipewire-ic-ipc. This library allows sending two commands: IC Applications are expected to send the SUSPEND command before starting playback of a sound to their dedicated ALSA device. The RESUME command should be sent after playback of this IC -sound has finished. +sound has finished. It should be noted that the RESUME command is also issued automatically when the IC application disconnects from the pipewire-ic-ipc UNIX socket. diff --git a/docs/7_How_To_Contribute/8_Adding_Documentation.md b/docs/7_How_To_Contribute/8_Adding_Documentation.md index 7797ab5..3777ecc 100644 --- a/docs/7_How_To_Contribute/8_Adding_Documentation.md +++ b/docs/7_How_To_Contribute/8_Adding_Documentation.md @@ -49,16 +49,23 @@ Find existing or add new markdowns in the following directory structure. ```sh documentation ├── docs -│ ├── 0_Getting_Started +│ ├── 1_Getting_Started │ │ ├── 1_Quickstart │ │ └── 2_Building_AGL_Image | ├── ..... | | -| ├──<Chapter-Number>_<Chapter-Name> -| | ├──<Subchapter-Number>_<Subchapter-Name> -| | | ├──<Index-Number>_<Markdown-Title>.md +| ├──<Chapter_Number>_<Chapter_Name> +| | ├──<Subchapter_Number>_<Subchapter_Name> +| | | ├──<Index_Number>_<Markdown_Title>.md | | | ├── ..... ``` +**File Naming convention** AGL follows Snake Case (snake_case) naming convention to name the documentation files. +This type of naming combines words simply by replacing the space with an underscore (_). +All the names will also include a index number before the name. +Index number will use two digit numbers from 01-99 followed by name of the file. +For example: If the file name is Build Process then it will be written as 01_build_process.md + +**Note:** If a file needs to be inserted in between already created sequences, then the index number will be the last index number followed by new numbering. For example, A new file is inserted between 06-07, then the index number for the new file will be 07_01, as in gist sorting, 07_01 will appear after 06 and before 07. ## Markdown Formatting @@ -74,6 +81,9 @@ documentation ```sh [<enter-title>](../<Chapter-Number>_<Chapter-Name>/<Subchapter-Number>_<Subchapter-Name>/<Index-Number>_<Markdown-Title>.md) + + + ``` ## Test Hyperlinks |