chore: github stuff - #209
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| @@ -0,0 +1,26 @@ | |||
| version: 2 | |||
| updates: | |||
| - package-ecosystem: npm | |||
| - minor | ||
| - patch | ||
|
|
||
| - package-ecosystem: github-actions |
⚡ Lighthouse reportAudited the Vercel preview deployment: https://webpack-doc-ebwb68a7i-openjs.vercel.app
|
Co-authored-by: Sebastian Beltran <bjohansebas@gmail.com>
| In the above example, `npm run build` runs the whole pipeline (it downloads the webpack releases in `versions.json` and generates their API docs), so it takes a few minutes. After that, if you are only editing hand-written pages, regenerate just the HTML: | ||
|
|
||
| ```sh | ||
| npm run build:html | ||
| ``` |
There was a problem hiding this comment.
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.
for now there is not.
should this feature be at doc-kit side or here?
There was a problem hiding this comment.
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.
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.
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.
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. 🙂
Co-authored-by: Sebastian Beltran <bjohansebas@gmail.com>
Adds stuff to improve the GitHub UI including: