Reorganise and revitalise #172
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Since we've migrated away from GitHub's Wiki system, we can actually
have our docs organised in a sane structure. Our docs fall into a few
pretty contained categories:
- alt: documentation for distribution maintainers
Note that this is *not* for distro-specific documentation.
We ask that distro maintainers use their distro's own documentation
infrastructure for that kind of information. This is
- fw: vendor-controlled firmware and its interfaces. All documentation
for iBoot, SecureROM, SEPFW, RTKit, WiFi/BT, etc. should go here.
While m1n1 and U-Boot are "firmware" from the running operating
system's perspective, they are not firmware from a platform or
project perspective.
- hw: documentation for system hardware
- cpu: anything related to the application processors, e.g. Apple's
ISA extensions, register definitions, etc.
- devices: machine-specific documentation, e.g. Mac model numbers
- peripherals: hardware not integrated into the SoC itself, e.g.
webcam, speakers, keyboard, trackpad, etc.
- soc: functional hardware blocks integrated into the SoC, e.g.
SMC, video codecs, display controllers, etc.
- platform: documentation applicable platform-wide, such as the security
architectire, boot flow, standard SSD partition map, etc.
- feature-support: feature support lists, separated by SoC generation
- project: documentation related to the project itself. FAQs, references,
etc.
- sw: documentation for all software components that are not considered
firmware. This includes m1n1, U-Boot, Linux kernel/userspace, etc.
This commit also ensures that all links resolve correctly.
Signed-off-by: James Calligeros <jcalligeros99@gmail.com>
Signed-off-by: James Calligeros <jcalligeros99@gmail.com>
Makes it a lot nicer to work with in a text editor Signed-off-by: James Calligeros <jcalligeros99@gmail.com>
The blog post list was in age-descending order. This makes no sense. Flip the order so that the most recent blog post is at the top of the list. Signed-off-by: James Calligeros <jcalligeros99@gmail.com>
We have been "just getting started" for five years. Time for a change. Signed-off-by: James Calligeros <jcalligeros99@gmail.com>
Signed-off-by: James Calligeros <jcalligeros99@gmail.com>
The correct place for distribution-specific information is that distro's documentation infrastructure. Signed-off-by: James Calligeros <jcalligeros99@gmail.com>
Signed-off-by: James Calligeros <jcalligeros99@gmail.com>
This page was a stub of very little value Signed-off-by: James Calligeros <jcalligeros99@gmail.com>
Conan-Kudo
approved these changes
Mar 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As promised, the repo has been reorganised so that the docs are a little easier to maintain and URLs are less insane. I've also touched up the homepage and added proper titles to every other page