doc: Add per-device pages #120
Merged
+383
−115
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
The headings have been pushed one lower.
Most of that fluff is about an upcoming feature, for per-device pages.
Still linking to the GitHub pages, but still a step forward.
Put the identifier first, since this is what they're sorted on. Then, put Manufacturer and Name in their own column.
This is to be used by the documentation system, without requiring to repeat all of the code.
samueldr
force-pushed
the
docs/improvements
branch
from
b9c3982 to
81b0e73
Compare
Rather than use ugly nix-templated bash.
Using Erb they are templated.
|
Some system types have no documentation, but that's not something that should stop this from being merged. The most important bits (android-based devices, and the pinephone) have appropriate documentation. |
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.
They will automatically embed the content of README.adoc from the device folder.
TODO
Rewrite the gnarly bash in a ruby script
I went one step too far, and I need a real programming language with real handling of strings to deal with some of the "magic" in handling those files.
This will also be useful for the next TODO, as it will reduce the headaches.
Basically, apply the same logic, but in a more manageable way.
Embed generic instructions
Templated instructions will be needed. They should automatically be added to a device page according to its system type.
Some things to consider:
So it'll need a bit more parameterization than simply relying on the system type.
Another thing to consider is that those documentation files should be trivial enough to work with, so likely flat .adoc files, though highly possibly templated with .erb.