-
-
Notifications
You must be signed in to change notification settings - Fork 126
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: move gh wiki to mdBooks #211
Closed
Closed
Conversation
This file contains 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.
To make this I setup a GitHub action that compiles every markdown file in
docs/src
to a mdBooks instance hosted on this repo's GitHub Page.All the markdown files should be almost identical to the ones in the current GitHub wiki since I cloned the
ags.wiki
repo. However, I did some changes to the landing page and had all the links to the wiki changed to relative paths. We might need to triple check if all of those work.If you merge this you'll need to set this up: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-first-deployment-with-github_token

That link wasn't too clear for me but basically, because the action makes a separate branch for the mdBooks, the Page needs to use that branch. So you just need to change the settings after it deploys once like so: