Initial Docs #200
Merged
Initial Docs #200
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.
Initial WiCan Docs repo.
The site runs Nuxt Content as well as Docus, see
docs/content/Contributing.mdon how to run and preview it locally.It will deploy to a branch
github_pageswhenever changes are pushed which can be set up to deploy to GH pages.I went with Nuxt Content + Docus, as it gives us the template for "free" and it effectivatly turns a foler of markdown files into a website.
The main site readme is getting bigger and bigger. The idea would be once this is up and working to migrate most of the content from the main readme, and wiki, and discussions etc into these docs to make it easy to view and read various docs.
Having it in-repo means as changes are made to various things any PR/commit made to edit things can keep the docs up to date at the same time.