Skip to content

docs: prepare to include developer docs#1249

Merged
mmattel merged 1 commit into
masterfrom
prepare_for_dev_docs
May 5, 2026
Merged

docs: prepare to include developer docs#1249
mmattel merged 1 commit into
masterfrom
prepare_for_dev_docs

Conversation

@mmattel
Copy link
Copy Markdown
Contributor

@mmattel mmattel commented May 5, 2026

This PR PREPARES for the migration of the dev docs.

From the outside there are two points to mention:

  • Nothing changes for existing links, all are page aliased
  • We have a new admin module (book) where the former data is embedded
  • The developer module (book) is prepared, "contentless" and currently removed from rendering

The changes include:

  • Create the required structure
  • Move the content formerly in the ROOT to the admin module
  • Create page-aliases for all pages
  • Update the nav structure
  • Disable any rendering of the developer module by commenting the nav entry in ROOT
    • Prepare an index page for dev docs so we can easily enable/test
  • Update of the repos site.yml file. Note that this only impacts local rendering

@mmattel mmattel requested a review from kobergj May 5, 2026 12:10
@mmattel mmattel added the documentation Improvements or additions to documentation label May 5, 2026
@mmattel mmattel merged commit 3ed0a77 into master May 5, 2026
4 checks passed
@mmattel mmattel deleted the prepare_for_dev_docs branch May 5, 2026 12:42
mmattel added a commit that referenced this pull request May 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants