-
Notifications
You must be signed in to change notification settings - Fork 85
docs: add tutorialkit.dev website #78
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
Conversation
|
|
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 looks great! 🎉
docs/tutorialkit.dev/.gitignore
Outdated
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 file can probably be removed?
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 think I'll keep it for tutorialkit.dev
specific files/folders. Like this one also has .env
and .env.production
. I don't think they are used though, but maybe they are?
The .astro
folder is something specific to this folder and I don't think it makes much sense to move that to the root?
So the file would then look like this
# generated types
.astro
# environment variables
.env
.env.production
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.
Ah good point! Yep let's simplify it but keep it 👍
package.json
Outdated
@@ -7,6 +7,8 @@ | |||
"prepare": "is-ci || husky install", | |||
"template:dev": "TUTORIALKIT_DEV=true pnpm run build && pnpm run --filter=tutorialkit-starter dev", | |||
"template:build": "pnpm run build && pnpm run --filter=tutorialkit-starter build", | |||
"tkit": "pnpm run --filter=tutorialkit.dev dev", |
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 if this was "docs"
instead of "tkit"
?
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.
So first I had docs
. It had 2 minor "issues"
- You can't run
pnpm docs
, because it opens the pnpm documentation. So you need to runpnpm run docs
. - If we are moving the demo over to this repo as well, it might be confusing?
I don't know, it's not big of a deal and we could always just have pnpm run demo
and pnpm run docs
. Maybe that's better?
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.
Oh I quite like pnpm run demo
and pnpm run docs
! 🌟
It's a bummer that pnpm docs
doesn't work. Maybe we could have docs-site
instead?
Although I think I prefer pnpm run docs
to pnpm docs-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.
Yeah I agree. I'll update 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.
🤩
This PR moves the website from
tutorialkit.dev
into this repository.I moved it inside the
docs/tutorialkit.dev
folder. The reason I didn't move it directly intodocs
is because we also want to move the demo inside this repository, which I would put underdocs/demo
. I'm open to suggestions though. We could also dodocs
anddemo
in the root of the project for instance.