Skip to content

feat: Add build steps to import architecture docs from the engine repository to contributors/engine/architecture#528

Open
ferafiks wants to merge 4 commits into
stride3d:masterfrom
ferafiks:architecture
Open

feat: Add build steps to import architecture docs from the engine repository to contributors/engine/architecture#528
ferafiks wants to merge 4 commits into
stride3d:masterfrom
ferafiks:architecture

Conversation

@ferafiks

@ferafiks ferafiks commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Description

Adds new steps Copy-ArchitectureDocs and Generate-ArchitectureDocsToc that import architecture docs from https://github.com/stride3d/stride/tree/master/docs to the contributors section.

Copy-ArchitectureDocs

  1. Deletes contributors/engine/architecture
  2. Copies architecture-index.md to architecture/index.md
  3. Copies all files from ../stride/docs to contributors/engine/architecture (the engine repository needs to be present at the same level, just like when building api).
  4. Renames README.md files to index.md.
  5. Replaces relative links to files outside of the docs folder in the engine repository with links to those files on github.
  6. Corrects links to renamed README pages.

Generate-ArchitectureDocsToc

  1. Deletes previous toc.yml file
  2. Sorts the list of pages
  3. Tries to find the name of the page from it's contents, falling back on the file name.
  4. Retrieves the relative link to the page, if it exists (some directories do not have an index page)
  5. Writes the page name and link (if successfully retrieved) to the toc.yml file
  6. Appends items: if it's an index page

The architecture toc.yml file is then imported in the main contributors toc.yml file

Related issues

Note

I did not update the build pipeline docs, nor github actions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat: Add asset system contributor documentation

1 participant