Skip to content

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

Merged
merged 5 commits into from
Jun 19, 2024
Merged

docs: add tutorialkit.dev website #78

merged 5 commits into from
Jun 19, 2024

Conversation

SamVerschueren
Copy link
Contributor

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 into docs is because we also want to move the demo inside this repository, which I would put under docs/demo. I'm open to suggestions though. We could also do docs and demo in the root of the project for instance.

Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

changeset-bot bot commented Jun 19, 2024

⚠️ No Changeset found

Latest commit: 34a5a0c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Member

@Nemikolh Nemikolh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great! 🎉

Copy link
Member

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?

Copy link
Contributor Author

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

Copy link
Member

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",
Copy link
Member

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"?

Copy link
Contributor Author

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"

  1. You can't run pnpm docs, because it opens the pnpm documentation. So you need to run pnpm run docs.
  2. 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?

Copy link
Member

@Nemikolh Nemikolh Jun 19, 2024

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.

Copy link
Contributor Author

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.

Copy link
Member

@Nemikolh Nemikolh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤩

@SamVerschueren SamVerschueren merged commit db233c7 into main Jun 19, 2024
6 checks passed
@SamVerschueren SamVerschueren deleted the docs/add-tkitdev branch June 19, 2024 13:29
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.

2 participants