Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
chore: github stuff #209
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
Uh oh!
There was an error while loading. Please reload this page.
chore: github stuff #209
Changes from all commits
d88bb5221c7cf145bae70File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Uh oh!
There was an error while loading. Please reload this page.
There are no files selected for viewing
Check warning
Code scanning / zizmor
insufficient cooldown in Dependabot updates: insufficient implicit default-days (less than 7) Warning
Check warning
Code scanning / zizmor
insufficient cooldown in Dependabot updates: insufficient implicit default-days (less than 7) Warning
Uh oh!
There was an error while loading. Please reload this page.
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.
Is there any way to preview changes live when I'm only editing a single page, without having to rebuild the entire 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.
for now there is not.
should this feature be at doc-kit side or here?
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.
probabily doc-kit
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.
No, not doc kit, here, I think. Some sort of --watch system, right?
eg look at the diff and only build changed pages + watch
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.
Hmm, I feel like that's more of a responsibility for doc-kit than for this project, though. I mean, why would we have our own watch system?
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 don't think it's in doc-kit, doc-kit doesn't check if output has changed since it's last build, it just takes the input and produces output. It's on the consumer to determine what inputs to pass to doc-kit (IMO)
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.
However you prefer. I'm not the maintainer of doc-kit, this is just feedback.
One thing that tends to characterize documentation tooling is making the development experience as smooth as possible. A big reason people adopt these tools is because they provide a good DX for writing and maintaining docs. 🙂
For example, in Express we have contributors who aren't developers at all. They focus entirely on the documentation because they're good at writing and organizing it. They don't really care about implementation details—they just want to run a single command, have the site start, and see their changes immediately.
This project is a bit different since everyone here is a developer, so it's less of a concern. And as a last resort, we'll always have Vercel previews to verify the changes. 🙂
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.