Create new documentation site based on README #232
Merged
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
|
Awesome @etekweb I'll take a look! |
appy-one
approved these changes
Jul 17, 2023
|
The docs are now live at https://appy-one.github.io/acebase/ |
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.
Adds a new documentation site based on the current README.md file. This approach is much easier to navigate than the current docs since you can use the navigation bar on the left-hand side (as discussed in #95).
Future Development
After the documentation site is published, the main repo README.md file can then be dramatically simplified to just contain the basic project info and a link to the documentation site.
Also, it would probably be useful to ultimately divide the README file into multiple subpages. This will reduce the overall amount of information on first load, as well as simplifying future updates to the documentation.