Created a basic documentation site auto-hosted through GitHub Pages #244
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
added 11 commits
August 25, 2023 13:10
Uncommented the deploy actions in pages.yml.
Moved the set-up guide into guides folder.
Began adding high level overview of lobby to guides.
format in overview.md
extensive help of badosu.
|
Added Dark/Light theme and Github Logo with a lot of help from badosu. New version:
|
|
Great idea thanks! |
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.
Took a lot of the work from https://beyond-all-reason.github.io/spring/ and attempted to begin a compatible equivalent also using the just-the-docs template. Extremely bare bones currently, but will be very easy to add to in the future and because it uses the exact same framework, anyone who has made any documentation for spring will already know how to make any future documentation for bar-lobby.
Additionally, I included a basic workflow pages.yml which will currently build and deploy the site automatically to the url: https://beyond-all-reason.github.io/bar-lobby/ whenever the files inside of ./docs are changed in the master branch. This can be changed to trigger on different events or on some time interval instead.
Below are a few screenshots of the pages I have already started building based off the https://www.youtube.com/watch?v=bVcKYPvVE8Q&t video.