The current https://seabios.org/ website uses the mediawiki software
and its only contents mirror the content from the repository docs/
directory.  I have been manually copying content from that docs
directory to the website when there are changes.

It would be preferable to automatically generate the website from the
docs directory (by automatically converting the mardown files to
html).  Doing so would reduce the manual work and would avoid needing
to maintain the mediawiki instance.

This set of patches makes some minor changes to the markdown and
introduces the scripts needed to use the "mkdocs" infrastructure for
generating the html.

-Kevin


--

Kevin O'Connor (3):
  docs: Fix document links
  docs: Rename docs/SeaBIOS.md to docs/index.md
  docs: Add mkdocs build tools for building the seabios.org website

 docs/Build_overview.md                | 13 +++---
 docs/Contributing.md                  |  4 +-
 docs/Debugging.md                     |  3 +-
 docs/Developer_Documentation.md       | 23 +++++-----
 docs/Download.md                      |  2 +-
 docs/Execution_and_code_flow.md       |  9 ++--
 docs/Linking_overview.md              | 16 +++----
 docs/Memory_Model.md                  |  6 +--
 docs/Releases.md                      |  2 +-
 docs/Runtime_config.md                |  4 +-
 docs/SeaVGABIOS.md                    |  8 ++--
 docs/_website/README                  | 12 ++++++
 docs/_website/mkdocs-requirements.txt | 10 +++++
 docs/_website/mkdocs.yml              | 62 +++++++++++++++++++++++++++
 docs/{SeaBIOS.md => index.md}         | 12 +++---
 15 files changed, 138 insertions(+), 48 deletions(-)
 create mode 100644 docs/_website/README
 create mode 100644 docs/_website/mkdocs-requirements.txt
 create mode 100644 docs/_website/mkdocs.yml
 rename docs/{SeaBIOS.md => index.md} (60%)

-- 
2.50.1


_______________________________________________
SeaBIOS mailing list -- seabios@seabios.org
To unsubscribe send an email to seabios-leave@seabios.org

On Wed, Aug 06, 2025 at 11:33:16PM +0000, Kevin O'Connor via SeaBIOS wrote:
> The current https://seabios.org/ website uses the mediawiki software
> and its only contents mirror the content from the repository docs/
> directory.  I have been manually copying content from that docs
> directory to the website when there are changes.
> 
> It would be preferable to automatically generate the website from the
> docs directory (by automatically converting the mardown files to
> html).  Doing so would reduce the manual work and would avoid needing
> to maintain the mediawiki instance.
> 
> This set of patches makes some minor changes to the markdown and
> introduces the scripts needed to use the "mkdocs" infrastructure for
> generating the html.

FYI, I committed this change.

-Kevin

_______________________________________________
SeaBIOS mailing list -- seabios@seabios.org
To unsubscribe send an email to seabios-leave@seabios.org

Am Freitag, 22. August 2025, 20:07:12 Mitteleuropäische Sommerzeit schrieb 
Kevin O'Connor:
> FYI, I committed this change.

The website will be autogenerated from that within an hour after commit.

The mediawiki instance is shut down (but still lingers around for a while, in 
case this change turns out to be catastrophic in some way.)


All the best,
Patrick_______________________________________________
SeaBIOS mailing list -- seabios@seabios.org
To unsubscribe send an email to seabios-leave@seabios.org