-
Notifications
You must be signed in to change notification settings - Fork 38
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
documentation-site #374
documentation-site #374
Conversation
Whoa thanks! Can you walk me through the high level changes? The diff is pretty large. |
I modified the theme with docz-theme-extended. The normal docz website does not have some basic documentation features plus is also not good looking. |
Hey Caddy 👏🏿, I need you to go through the website menu and check for any improvements that can be made. I want to know if there are any other new sections that you would like to be added to the website and if you are okay with the current naming and structuring. I'm also thinking of creating a quick start guide with the warthog-starter project, the tutorial will guide a new user through executing queries and permutations. |
Just started reviewing :) |
@@ -3,11 +3,16 @@ | |||
"title": "Warthog", |
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.
Does this typically get committed or should this only be built and uploaded and not stored in source control?
@@ -0,0 +1,36 @@ | |||
// https://www.docz.site/docs/project-configuration |
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.
What is this file used for now? It doesn't seem to be up to date with what I'm viewing on the site.
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.
Ok, per docz own documentation we should gitignore the whole .docz
folder:
@@ -21,6 +21,7 @@ | |||
"serve": "gatsby serve" |
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.
Please delete the package-lock.json
as I use yarn.
@@ -0,0 +1,51 @@ | |||
--- |
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.
Let's remove this page. Warthog users aren't going to add plugins to the CLI.
export default { | ||
themeConfig: { | ||
initialColorMode: 'dark' | ||
initialColorMode: 'dark', |
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.
@@ -1,6 +1,6 @@ | |||
--- | |||
name: Upgrading to 2.0 | |||
menu: Upgrading | |||
menu: Upgrading Guides |
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.
Pls keep as Upgrading.
Hey, the changes look great, thanks. I've left some comments. In general, before we can merge, we'll need:
I'm on vacation right now - will try to get this done over the weekend. |
As for the |
] | ||
}, | ||
{ | ||
name: 'Warthog CLI', |
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.
This should just be "CLI"
@@ -0,0 +1,9 @@ | |||
--- |
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.
I'm not sure the CLI needs sub-pages. The only command that is complex is generate
, so it could probably all be on one page for now.
@@ -0,0 +1,9 @@ | |||
--- |
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.
The decorators are fairly trivial - not sure we need a different menu for each. We could put in one page and then use the right menu for navigation.
Merged. Will incorporate my feedback right now - I have time to play with this. |
Updates made here and new PR created: #379 |
documentation (#374) chore(docz): adds docz documentation site fix(gitignore): ignore .docz folder updates more updates
I just want to create a quick start guide for warthog with the project, something like prisma quickstart. The guide will involve issuing queries and mutations with warthog, just something to just give newcomers a brief overview of working with warthog without making them go through the full installation process. |
Sure, sounds good. Ideally this would be hosted in the main docs, not on the starter repo. Why don't you come up with something in markdown format and I'll take a look at it? |
I made some changes to the documentation site