Skip to content

doc: first draft from Claude#394

Draft
dtoshniwal wants to merge 4 commits into
devfrom
docs/claude-proposals
Draft

doc: first draft from Claude#394
dtoshniwal wants to merge 4 commits into
devfrom
docs/claude-proposals

Conversation

@dtoshniwal

Copy link
Copy Markdown
Contributor

@apalha @J15525 @dccabanas

Hey all, here is a quick showcase of something that could save us all a significant amount of time (and which, based on the results, looks hard to argue against): using Claude/... to generate our first drafts of documentation. I already showed this to Joey and Artur but adding it here so that we can all play around with it a bit more.

All modifications in this PR were generated automatically by Claude in a few minutes, all I gave was a very high level prompt. Even if it was a non-specific prompt, the results look good, and to me the potential of doing this is quite clear (e.g., the different types of new examples, the introductory parts of Assemblers/Quadrature/FunctionSpaces/Analysis modules). With more specific prompting (maybe focused on a specific module at a time?), we will probably get excellent results that would require few modifications.

Yes, the generated text is not going to be 100% final or correct, and it will still require review. But that's also true for any other text that any of us will write, so that's not something that should stop us from going in this direction.

What this means is that, instead of dedicating days for writing documentation and creating figures from scratch (and making limited progress in those days), we can use these tools to create first drafts and better spend our time reviewing the drafts and improving them.

Take a look at this PR if you can before the next meeting, and let's discuss this then.

@dccabanas
dccabanas force-pushed the docs/claude-proposals branch from a93d123 to 46f9f50 Compare June 22, 2026 07:48
@dccabanas

Copy link
Copy Markdown
Member

@dtoshniwal I think this is a good idea overall, as long as we review things carefully. I tried to build the docs locally to see what they look like, but I get some errors due to missing figure files. Can you check that everything works, and possibly push a fix if it doesn't?

@dtoshniwal

Copy link
Copy Markdown
Contributor Author

@dtoshniwal I think this is a good idea overall, as long as we review things carefully. I tried to build the docs locally to see what they look like, but I get some errors due to missing figure files. Can you check that everything works, and possibly push a fix if it doesn't?

A couple of figures were missing, pushed them now.

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