Skip to content

Commit

Permalink
docs: Fix md styles
Browse files Browse the repository at this point in the history
Signed-off-by: Norbert Kamiński <norbert.kaminski@3mdeb.com>
  • Loading branch information
Norbert Kamiński committed Jul 24, 2023
1 parent 5dac43f commit cdc0832
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 20 deletions.
4 changes: 2 additions & 2 deletions docs/common-coreboot-docs/dumping_logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ with the firmware. This method requires Secure Boot to be disabled.
Options to get `cbmem` utility:

1. Download precompiled utility from [3mdeb cloud](https://cloud.3mdeb.com/index.php/s/zTqkJQdNtJDo5Nd/download)
2. Use [Dasharo Tools Suite](https://docs.dasharo.com/dasharo-tools-suite/releases#v110) v1.1.0 or
newer which has `cbmem` utility built in.
2. Use [Dasharo Tools Suite](https://docs.dasharo.com/dasharo-tools-suite/releases#v110)
v1.1.0 or newer which has `cbmem` utility built in.
3. Compile `cbmem utility`. See procedure below.

Short instruction how to compile and use `cbmem` on Ubuntu 22.04 live CD:
Expand Down
4 changes: 2 additions & 2 deletions docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ keep content added by us minimalistic.
## Embedded Firmware

We use definition explained in first chapter of
["Embedded Firmware Solutions"](https://link.springer.com/book/10.1007/978-1-4842-0070-4) book
by Jiming Sun, Marc Jones, Stefan Reinauer and Vincent Zimmer.
["Embedded Firmware Solutions"](https://link.springer.com/book/10.1007/978-1-4842-0070-4)
book by Jiming Sun, Marc Jones, Stefan Reinauer and Vincent Zimmer.

Firmware is "layer of software between the hardware and the
operating system (OS), with the main purpose to initialize and
Expand Down
18 changes: 10 additions & 8 deletions docs/osf-trivia-list/dasharo.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ Dasharo is an open-source firmware distribution focusing on:

Dasharo consists of [productized services](#dasharo-professional-support), set
of [open-source repositories](https://github.com/orgs/Dasharo/repositories),
and [quality control](https://docs.dasharo.com/unified-test-documentation/overview/) which help to
provide scalable, modular, easy to combine open-source BIOS, UEFI, and firmware
solutions. It offers the components that are needed to develop and maintain a
high quality, and modular firmware, for the stability and security of your
platform.
and [quality control](https://docs.dasharo.com/unified-test-documentation/overview/)
which help to provide scalable, modular, easy to combine open-source BIOS, UEFI,
and firmware solutions. It offers the components that are needed to develop
and maintain a high quality, and modular firmware, for the stability and
security of your platform.

For individuals Dasharo provides optional features in subscription model called
[Supporters Entrance](dts.md#how-to-get-dasharo-tools-suite-supporters-entrance).
Expand Down Expand Up @@ -284,7 +284,8 @@ is the improvements made to fork maintenance, currently being tracked in [this
issue](https://github.com/Dasharo/dasharo-issues/issues/310) on the Dasharo
GitHub repository. The project also explores the concept of a bootstrapable
toolchain, discussed in the [build process
section](https://docs.dasharo.com/osf-trolling-list/build_process) of the project documentation.
section](https://docs.dasharo.com/osf-trolling-list/build_process)
of the project documentation.

### Dasharo Long Term Maintenance

Expand Down Expand Up @@ -480,8 +481,9 @@ such a case, don't hesitate to contact us; we will see what we can do. However,
the community member who requested support for the platform should also offer
their help in validating the firmware and maintenance. That kind of request
will be more than welcome from active community members. New members should
consider [ways to help us](https://docs.dasharo.com/ways-you-can-help-us/) to gain a reputation
that can lead to influencing Dasharo Community Supported roadmap.
consider [ways to help us](https://docs.dasharo.com/ways-you-can-help-us/)
to gain a reputation that can lead to influencing Dasharo Community Supported
roadmap.

[coreboot-scope]: https://doc.coreboot.org/#scope-of-the-coreboot-project
[dtsos]: ../dasharo-tools-suite/overview.md
Expand Down
4 changes: 2 additions & 2 deletions docs/variants/asus_kgpe_d16/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,8 @@ option to connect a TPM, we use the header for that purpose.
IMPORTANT: Use only TPM modules which match their pinout with the board's
header! Using a spider web connection degrades the signal quality to the point
where CPU cannot properly talk to TPM via LPC bus. Tested with
[PC Engines TPM module](https://shop.3mdeb.com/shop/modules/tpm-2-0/) and failed to
succeed this way. Designing and producing proper TPM header and/or reliable
[PC Engines TPM module](https://shop.3mdeb.com/shop/modules/tpm-2-0/) and failed
to succeed this way. Designing and producing proper TPM header and/or reliable
adapter, could solve this problem. The [TwPM
project](https://twpm.dasharo.com/) could help here in the future.

Expand Down
4 changes: 2 additions & 2 deletions docs/variants/msi_z690/hcl.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,8 +197,8 @@ Maintainer documentation](https://docs.dasharo.com/dev-proc/hcl-maintainer).
## Contributing

- Use [Dasharo Tools Suite HCL
report](https://docs.dasharo.com/dasharo-tools-suite/documentation/#hcl-report) to upload
report automatically.
report](https://docs.dasharo.com/dasharo-tools-suite/documentation/#hcl-report)
to upload report automatically.
- Create new issue in [Dasharo issues
repository](https://github.com/Dasharo/dasharo-issues/issues/new?assignees=&labels=P%3A+default%2C+T%3A+hcl&template=hcl-report.md&title=CPU+HCL+report+for+msi_z690).
- Create PR directly to [Dasharo documentation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ following unofficial guides deviating in any way from the official
instructions.

If you have trouble with the installation process, ask for help on the official
[Dasharo chat channel](https://docs.dasharo.com/#community). There are almost always people
around willing to help with it. Before asking for help, make an attempt to
follow the guide on your own and then ask for help with anything you get stuck
on.
[Dasharo chat channel](https://docs.dasharo.com/#community). There are almost
always people around willing to help with it. Before asking for help, make an
attempt to follow the guide on your own and then ask for help with anything you
get stuck on.

## Hardware preparation

Expand Down

0 comments on commit cdc0832

Please sign in to comment.