Repository navigation
docs(nx-object): repoint the dead format references - #9
Merged
Merged
Conversation
The README still described the layers by a feature that no longer exists, and a third of the wiki pages the crate cites have been renamed or removed since they were written, so a reader following one lands on a 404 rather than on the structure the code mirrors. - Rewrite the README against the current runtime tiers: `raw` and `read` need no allocator, `write` needs a heap, and only the `from_directory` builders need a filesystem. Drop the feature table, which restated what each feature's own doc comment already says. - Repoint every reference that moved: `KIP` to `KIP1`, the MOD0 header to `MOD`, and `PFS0` to the `NCA` page that absorbed it, along with the section anchors switchbrew renamed on the NRO, NSO, NACP and NPDM pages. - Cite the 3DS page for RomFS, whose layout the console inherits unchanged, since switchbrew documents the format nowhere. - Name the layers in the crate docs rather than linking them, so the table can describe the crate whole without a lean build leaving a link with nothing to resolve to. Signed-off-by: Lorenzo Delgado <lnsdev@proton.me>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The README and AGENTS.md both still described the layers by a feature that no longer exists, and a third of the wiki pages the crate cites have been renamed or removed since they were written, so a reader following one lands on a 404 rather than on the structure the code mirrors.
rawandreadneed no allocator,writeneeds a heap, and only thefrom_directorybuilders need a filesystem. Drop the feature table, which restated what each feature's own doc comment already says.KIPtoKIP1, the MOD0 header toMOD, andPFS0to theNCApage that absorbed it, along with the section anchors switchbrew renamed on the NRO, NSO, NACP and NPDM pages.filesystem-supportfeature table with the two axes that select a build now, correct theno_stdproof to the command CI runs, and point at the##doc comments inCargo.tomlas the authoritative description of each feature.