Skip to content

[NFC] Let's all thank claude for helping complete the jsg docs#5700

Merged
jasnell merged 8 commits intomainfrom
jasnell/complete-more-jsg-docs
Dec 17, 2025
Merged

[NFC] Let's all thank claude for helping complete the jsg docs#5700
jasnell merged 8 commits intomainfrom
jasnell/complete-more-jsg-docs

Conversation

@jasnell
Copy link
Copy Markdown
Collaborator

@jasnell jasnell commented Dec 15, 2025

Gave claude the task of filling out more of the jsg docs and reorganizing them to flow better.

There are no functional changes here. All of the edits were made by claude. If you review and have edits, please make them in the form of suggestions that can be easily accepted in order to make the iteration process easier.

@jasnell jasnell requested review from a team as code owners December 15, 2025 22:57
@kentonv
Copy link
Copy Markdown
Member

kentonv commented Dec 15, 2025

Hmm, is this actually useful though? Probably nobody will read a doc this long, they'll just jump into the code... so the doc should cover high-level concepts that are hard to see by looking directly at the code.

Also if Claude can write this then Claude can also just answer people's questions directly by looking at the code on their behalf... :)

@jasnell
Copy link
Copy Markdown
Collaborator Author

jasnell commented Dec 15, 2025

well, this actually works well as a context guide for claude. I don't actually expect folks to read this entire thing. I was wanting to see about updating our doc structure a bit more such that it would be easier for claude to consume and use to answer questions.

that said, this took me all of about 30 minutes in between waiting for other tests on a different change to run, so it's not like I spent a ton of time on this. If it doesn't make sense to land, so be it.

@jasnell
Copy link
Copy Markdown
Collaborator Author

jasnell commented Dec 15, 2025

At the very least, it's a good exercise in seeing just how comprehensible the structure is. I noticed that it had a bit of difficulty understanding how the isolate setup/bootstrap worked and those details likely would need more clarification. For the most part it seems to have been able to grok most things but there are still some definite gaps.

Copy link
Copy Markdown
Member

@anonrig anonrig left a comment

Choose a reason for hiding this comment

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

This is helpful for finding things using grep as well as via Claude. Thanks!

@jasnell jasnell merged commit 9b7f628 into main Dec 17, 2025
19 checks passed
@jasnell jasnell deleted the jasnell/complete-more-jsg-docs branch December 17, 2025 21:44
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.

3 participants