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
Open
feat: Add build steps to import architecture docs from the engine repository to contributors/engine/architecture#528ferafiks wants to merge 4 commits into
contributors/engine/architecture#528ferafiks wants to merge 4 commits into
Conversation
8 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds new steps
Copy-ArchitectureDocsandGenerate-ArchitectureDocsTocthat import architecture docs from https://github.com/stride3d/stride/tree/master/docs to the contributors section.Copy-ArchitectureDocscontributors/engine/architecturearchitecture-index.mdtoarchitecture/index.md../stride/docstocontributors/engine/architecture(the engine repository needs to be present at the same level, just like when building api).README.mdfiles toindex.md.docsfolder in the engine repository with links to those files on github.READMEpages.Generate-ArchitectureDocsToctoc.ymlfiletoc.ymlfileitems:if it's an index pageThe architecture
toc.ymlfile is then imported in the main contributorstoc.ymlfileRelated issues
Note
I did not update the build pipeline docs, nor github actions.