Repository navigation
Docs refinements - #22
Closed
RobotOptimist wants to merge 34 commits into
Closed
RobotOptimist wants to merge 34 commits into
RobotOptimist wants to merge 34 commits into
Conversation
get latest from davidfowl
More hacks! Populate initial configuration object properly
Open
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.
#17
the ci job stuff is commented out pending a time where you might want to do the update from build. When you do that you'd need to generate an access-token so that the gh-pages deploy action can function
I've moved the markup style almost completely to markdown which should be more accessible for would be docs contributors who don't want to deal with writing html / css / js
However, all of the power and expressiveness of html / css / js can be engaged at anytime on a file by file basis at the author's whim, so that's cool.
Global styles are defined in docs/layouts/default.vue because it is simple and straightforward to do it that way, but we can change it to a global style sheet anytime. I'm using tailwindcss so that's why the styling looks the way it does. Most people won't have to think about it though, ease of contribution is the goal.
you can run the project locally just by doing these commands
(assuming nodejs is installed)
cd docsnpm installnpm run devyou can deploy to gh-pages any time you want from your local machine by doing the following:
cd docsnpm installnpm run generate:gh-pagesnpm run deployI've started writing copy around the main page, (index), getting started and hello world views. I think I'm going to need to pick your brain about this stuff and I'll be discussing that from the docs issue
Btw - this is just me taking a crack at a docs page similar to the go site using a framework I know well - but if this is not the direction to take for this project please let me know. My goal is always to be helpful, not to be a nuisance