Skip to content

Docs refinements - #22

Closed
RobotOptimist wants to merge 34 commits into
featherhttp:masterfrom
RobotOptimist:docs-refinements
Closed

RobotOptimist wants to merge 34 commits into
featherhttp:masterfrom
RobotOptimist:docs-refinements

Conversation

@RobotOptimist

Copy link
Copy Markdown
Contributor

#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 docs
npm install
npm run dev

you can deploy to gh-pages any time you want from your local machine by doing the following:
cd docs
npm install
npm run generate:gh-pages
npm run deploy

I'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

RobotOptimist and others added 30 commits January 22, 2020 07:19
get latest from davidfowl
More hacks! Populate initial configuration object properly
@RobotOptimist RobotOptimist mentioned this pull request Feb 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant