Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update docs #199

Merged
merged 12 commits into from
Jul 31, 2024
Merged

Update docs #199

merged 12 commits into from
Jul 31, 2024

Conversation

AtomicFS
Copy link
Collaborator

@AtomicFS AtomicFS commented Apr 17, 2024 •
edited
Loading

Mostly adding Getting started section with guide on how to use firmware-action.

Not sure if description of the multi-stage builds is sufficient (for example coreboot with edk2 as payload)

fixes #191

@AtomicFS AtomicFS marked this pull request as ready for review July 5, 2024 15:57
@AtomicFS AtomicFS added the documentation Improvements or additions to documentation label Jul 5, 2024
@AtomicFS AtomicFS requested a review from MDr164 July 8, 2024 14:47
@AtomicFS AtomicFS enabled auto-merge July 8, 2024 14:47
@AtomicFS AtomicFS force-pushed the docs branch 4 times, most recently from 77bbe94 to 64c6437 Compare July 10, 2024 10:28
@AtomicFS AtomicFS force-pushed the main branch 7 times, most recently from 0093774 to 2d33a7e Compare July 11, 2024 13:12
@AtomicFS AtomicFS force-pushed the docs branch 5 times, most recently from 7d9dabc to 0be6f20 Compare July 17, 2024 08:40
@AtomicFS AtomicFS force-pushed the docs branch 5 times, most recently from 9787c29 to a975f53 Compare July 26, 2024 10:27
@AtomicFS
Copy link
Collaborator Author

AtomicFS commented Jul 26, 2024 •
edited
Loading

FYI, to build the docs locally, you need to get some dependencies first:

cargo install \
  mdbook \
  mdbook-admonish \
  mdbook-footnote \
  mdbook-katex \
  mdbook-pagetoc \
  mdbook-template \
  mdbook-toc

BTW, these packages are also in Arch Linux AUR (some are even in mainstream repositories).

And then just run:

cd docs
mdbook build

Then in your browser open the file docs/public/index.html

@AtomicFS AtomicFS force-pushed the docs branch 2 times, most recently from 50902ae to abc26e1 Compare July 29, 2024 16:03
@AtomicFS AtomicFS force-pushed the docs branch 3 times, most recently from ed9f337 to edc01ac Compare July 30, 2024 14:55
MDr164
MDr164 reviewed Jul 31, 2024
View reviewed changes
docs/src/firmware-action/get_started/02_coreboot_config.md Outdated Show resolved Hide resolved
docs/src/firmware-action/interactive.md Show resolved Hide resolved
docs/theme/index.hbs Outdated Show resolved Hide resolved
@AtomicFS AtomicFS force-pushed the docs branch 2 times, most recently from ab82743 to 478d904 Compare July 31, 2024 10:17
AtomicFS added 12 commits July 31, 2024 12:21
@AtomicFS
docs: update README.md
05fe385 
Signed-off-by: AtomicFS <[email protected]>
@AtomicFS
docs(action): cleanup anchors in recipes
731db4f 
Signed-off-by: AtomicFS <[email protected]>
@AtomicFS
docs: split example_config files for more clarity
655ddb4 
Signed-off-by: AtomicFS <[email protected]>
@AtomicFS
docs: add firmware-action-example as submodule
f75bd2e 
Signed-off-by: AtomicFS <[email protected]>
@AtomicFS
docs: add more docs
1cd1ad7 
Signed-off-by: AtomicFS <[email protected]>
@AtomicFS
docs: add notes about interactive mode
c0ad599 
Signed-off-by: AtomicFS <[email protected]>
@AtomicFS
fix(lint): fixes according to megalinter
5b0b4dd 
Signed-off-by: AtomicFS <[email protected]>
@AtomicFS
fix(megalinter): exclude mdbook theme from linting
5145da9 
Signed-off-by: AtomicFS <[email protected]>
@AtomicFS
fix(lint): fix broken matching in .editorconfig
aed1ff5 
Signed-off-by: AtomicFS <[email protected]>
@AtomicFS
docs: add note about Arch Linux AUR package
fddf165 
Signed-off-by: AtomicFS <[email protected]>
@AtomicFS
docs: add note about interactive mode
a1537d6 
Signed-off-by: AtomicFS <[email protected]>
@AtomicFS
docs: remove google analytics from mdbook
24f1197 
Signed-off-by: AtomicFS <[email protected]>
@AtomicFS AtomicFS requested a review from MDr164 July 31, 2024 10:22
MDr164
MDr164 approved these changes Jul 31, 2024
View reviewed changes
Copy link
Collaborator

@MDr164 MDr164 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, let's hope I didn't miss anything again...

@AtomicFS AtomicFS added this pull request to the merge queue Jul 31, 2024
Merged via the queue into main with commit eab70ac Jul 31, 2024
37 checks passed
@AtomicFS AtomicFS deleted the docs branch July 31, 2024 10:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MDr164 MDr164 MDr164 approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Get started guide
2 participants
@AtomicFS @MDr164