-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
New Quick Start Guide #288
Conversation
- code-switcher plugin is not compatible with screenshots inside "tabs". - copy-code plugin is ready to be used but not configured yet
* Step 1 (installation) is written for both paths * Steps 2 & 3 are just outlines for now * Current Quick Start Guide file has not been deleted yet, but renamed * Added first screenshots
* Fix some formatting * Reword some parts * Add a few links
to avoid breaking links
Once [this issue]( vuejs/vuepress#2711) with VuePress is fixed, we might be able to use the prettier code-groups again :-)
It would imply that it's easy, and this is something to avoid in the documentation :-)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
docs/.vuepress/config.js
Outdated
@@ -383,7 +377,7 @@ module.exports = { | |||
title: '', | |||
port: 8080, | |||
description: 'The headless CMS developers love.', | |||
base: '/documentation/', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remember we need to revert this before we merge it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(Unless we merge in my fix PR)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the reminder, Derrick!
I've just reverted it and I suggest we don't change anything on the repo until deploying this Wednesday. We'll switch to a new infra in a few weeks anyway, so that will be the perfect moment to reconsider everything. Thank you! :-)
@@ -1,5 +1,5 @@ | |||
--- | |||
meta: | |||
- http-equiv: refresh | |||
content: 0;url=/documentation/developer-docs/latest/getting-started/introduction.html | |||
- http-equiv: refresh |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@derrickmehaffy Should I also revert this if we don't merge your workaround PR?
What does it do?
Rewrites the Quick Start Guide:
Note: It is highly encouraged that you compile this locally and read the final document in your browser, instead of just reviewing the text on Github. So you can benefit the most from the experience 🙂