Skip to content

Commit 92c4bdf

Browse files
chadmedConan-Kudo
authored andcommitted
README: document new directory structure
Signed-off-by: James Calligeros <[email protected]>
1 parent a6772e1 commit 92c4bdf

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

+17
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,23 @@
22

33
This is the [Asahi Linux documentation](https://asahilinux.org/docs/) repository.
44

5+
## Documentation structure
6+
Our documentation is organised into categories.
7+
8+
- alt: Alternative operating system/Linux distribution support documentation
9+
should go here.
10+
- fw: Documentation on vendor-controlled firmware and firmware interfaces should
11+
go here.
12+
- hw: Any documentation related to hardware belongs here. This is further split
13+
into subcategories:
14+
- cpu: Application processor documentation
15+
- devices: Documentation relating to specific Mac models
16+
- peripherals: hardware found in Apple Silicon Macs but not the SoC itself
17+
- soc: hardware blocks integrated into Apple Silicon SoCs
18+
- platform: Documentation that applies across the Apple Silicon platform
19+
- project: Project admin documents and stuff unrelated to hardware or software
20+
- sw: Documentation for non-firmware software
21+
522
## Usage
623

724
This is made with [MkDocs](https://www.mkdocs.org/). If you have mkdocs installed already, run `make build` to build the site, or `make test` to spin up a local webserver for review. If you don't, feel free to use our [container](https://github.com/AsahiLinux/docs/pkgs/container/mkdocs-asahi) with something like:

0 commit comments

Comments
 (0)