feat: add Code Documentation Generator recipe (#5121)

[ARYPROGRAMMER]

Summary

Advanced recipe for automated code documentation generation that analyzes source code and creates comprehensive, well-structured documentation with examples and best practices. Supports multiple programming languages (Python, JavaScript, TypeScript, Rust, Go, Java, etc.), multiple documentation formats, and customizable output styles.

Key Features:

• 3 Extensions Used: Developer (code analysis), Memory (pattern consistency), Browser (research standards)
• 6 Customizable Parameters: source_path, doc_format, include_examples, output_location, doc_style, language_hint
• 5 Documentation Formats: Markdown, HTML, reStructuredText, JavaDoc, JSDoc
• 3 Documentation Styles: Minimal, Standard, Comprehensive
• 5-Phase Orchestration: Analyze → Extract → Generate → Cross-Reference → Finalize
• Intelligent Research: Uses browser extension to fetch language-specific documentation standards
• Pattern Memory: Maintains consistency across multiple runs using memory extension
• Auto Language Detection: Detects programming language and applies appropriate standards
• Usage Examples: Generates realistic code examples with proper syntax

Type of Change

• Feature
• Bug fix
• Refactor / Code quality
• Performance improvement
• Documentation
• Tests
• Security fix
• Build / Release
• Other

Testing

Primary test command:

goose run --recipe documentation/src/pages/recipes/data/recipes/code-documentation-generator.yaml --params source_path=./ui/desktop/src --params doc_format=html --params include_examples=true --params output_location=./docs --params doc_style=comprehensive

Additional Tests:

# Minimal Markdown documentation for Python
goose run --recipe documentation/src/pages/recipes/data/recipes/code-documentation-generator.yaml --params source_path=./examples --params doc_format=markdown --params doc_style=minimal --params language_hint=python

# Standard documentation for current directory
goose run --recipe documentation/src/pages/recipes/data/recipes/code-documentation-generator.yaml --params source_path=. --params include_examples=true --params doc_style=standard

Manual Testing Completed:

• Validated YAML structure and syntax (passed)
• Confirmed all required fields present (version, title, description, instructions, activities)
• Verified 3 extensions properly configured (developer, memory, browser)
• Confirmed HTML documentation generation with proper formatting
• Validated parameter substitution and Jinja2 templating
• Verified memory extension stores documentation patterns
• Confirmed browser extension researches standards (JSDoc)
• Tested conditional logic for different doc_format and doc_style values

Related Issues

Fixes #5121

Screenshots/Demos

Email: [email protected]

[github-actions]

✅ Recipe Validation Passed

Your recipe(s) are valid and ready for review!

🔍 Next Steps:

1. Our team will review your recipe
2. If approved, we'll run a security scan
3. Once merged, you'll receive $10 in OpenRouter credits (if email provided)

Thanks for contributing to the goose Recipe Cookbook! 🎉

[github-actions]

🔍 Recipe Security Scan Results

✅ Status: APPROVED - All recipes passed security scan

📊 Scan Summary:

• Total recipes scanned: 1

📋 Individual Recipe Results:
✅ Recipe 1: APPROVED (LOW risk)

🔗 View detailed scan results in the workflow artifacts.

[iandouglas]

overall, I really like the recipe's idea. there are a few things I'd change, and a few thoughts to consider, but I think this will be a good addition to our cookbook!

[iandouglas]

links will work with the html format, but you might need to provide more direction here on what to do for markdown files, etc that you specify on line 40.

[ARYPROGRAMMER]

i will address all things in a while. thanks

[github-actions]

✅ Recipe Validation Passed

Your recipe(s) are valid and ready for review!

🔍 Next Steps:

1. Our team will review your recipe
2. If approved, we'll run a security scan
3. Once merged, you'll receive $10 in OpenRouter credits (if email provided)

Thanks for contributing to the goose Recipe Cookbook! 🎉

[ARYPROGRAMMER]

i think most of the things i have managed to add as per whatever knowledge i have from the docs. let me know further

[github-actions]

🔍 Recipe Security Scan Results

✅ Status: APPROVED - All recipes passed security scan

📊 Scan Summary:

• Total recipes scanned: 1

📋 Individual Recipe Results:
✅ Recipe 1: APPROVED (LOW risk)

🔗 View detailed scan results in the workflow artifacts.

[github-actions]

✅ Recipe Validation Passed

Your recipe(s) are valid and ready for review!

🔍 Next Steps:

1. Our team will review your recipe
2. If approved, we'll run a security scan
3. Once merged, you'll receive $10 in OpenRouter credits (if email provided)

Thanks for contributing to the goose Recipe Cookbook! 🎉

[github-actions]

🔍 Recipe Security Scan Results

✅ Status: APPROVED - All recipes passed security scan

📊 Scan Summary:

• Total recipes scanned: 1

📋 Individual Recipe Results:
✅ Recipe 1: APPROVED (LOW risk)

🔗 View detailed scan results in the workflow artifacts.

[ARYPROGRAMMER]

ok this too seems good to me now

[ARYPROGRAMMER]

@iandouglas pls take some time to finish this and other prs of mine. thanks

[taniandjerry]

Hi @ARYPROGRAMMER, I noticed that you went against the contribution rules and assigned yourself 4 recipe submission tasks to yourself at once. specifically #5119 , #5121 , #5122 and #5123 . This isn't fair to other community members, as the rules state to first get your first issue approved and merged before moving on to the next one. I'll be reviewing this with the team and getting back to you on what do to next!

Edit: technically 5 issues you self-assigned at once, with #5118 .

[ARYPROGRAMMER]

Hi @ARYPROGRAMMER, I noticed that you went against the contribution rules and assigned yourself 4 recipe submission tasks to yourself at once. specifically #5119 , #5121 , #5122 and #5123 . This isn't fair to other community members, as the rules state to first get your first issue approved and merged before moving on to the next one. I'll be reviewing this with the team and getting back to you on what do to next!

Edit: technically 5 issues you self-assigned at once, with #5118 .

surely , i request you to kindly unassign me in the case that this truly isnt fair. I had the prs ready and was waiting for the issue. sequentially these should have had been completed if my calculations were correct but since there was no review for a long time. these seem as a collective assignment- which was initially sequentially.

so technically i completed my part at one pr and then only assigned myself with another. [assuming the previous was approved - which wasnt]

let me know further. i am willing to drop the prs as requested by the team

cc: @taniandjerry

[taniandjerry]

Hi @ARYPROGRAMMER, I noticed that you went against the contribution rules and assigned yourself 4 recipe submission tasks to yourself at once. specifically #5119 , #5121 , #5122 and #5123 . This isn't fair to other community members, as the rules state to first get your first issue approved and merged before moving on to the next one. I'll be reviewing this with the team and getting back to you on what do to next!
Edit: technically 5 issues you self-assigned at once, with #5118 .

surely , i request you to kindly unassign me in the case that this truly isnt fair. I had the prs ready and was waiting for the issue. sequentially these should have had been completed if my calculations were correct but since there was no review for a long time. these seem as a collective assignment- which was initially sequentially.

so technically i completed my part at one pr and then only assigned myself with another. [assuming the previous was approved - which wasnt]

let me know further. i am willing to drop the prs as requested by the team

cc: @taniandjerry

Understandable! The review coming late was due to the extended weekend. I apologize for that, and understand wanting PRs reviewed asap! The team will always make sure to review within a 24-48 hour period on weekdays, while weekend PRs will result in a 48 hour minimum wait time ahead of review. In addition to any changes that may be requested. Just sharing for your reference!

But as you mentioned, since your PRs weren't reviewed before you self-assigned other recipe submissions, the feedback you were waiting for one PR could have been used in upcoming submissions. Waiting to take on another issue allows you to both make sure your contributions in progress are up to standard, and eliminates you taking opportunity away from community members.

For now, since I want your contributions to still count, while also taking into account the rules being dismissed at the time, what I will do is combine your recipe submissions into one PR, then unassign you from the others. And going forward, allow other contributors to submit recipes and maybe you can focus on other open issues that are open and will open this week. How does that sound?

[ARYPROGRAMMER]

Hi @ARYPROGRAMMER, I noticed that you went against the contribution rules and assigned yourself 4 recipe submission tasks to yourself at once. specifically #5119 , #5121 , #5122 and #5123 . This isn't fair to other community members, as the rules state to first get your first issue approved and merged before moving on to the next one. I'll be reviewing this with the team and getting back to you on what do to next!
Edit: technically 5 issues you self-assigned at once, with #5118 .

surely , i request you to kindly unassign me in the case that this truly isnt fair. I had the prs ready and was waiting for the issue. sequentially these should have had been completed if my calculations were correct but since there was no review for a long time. these seem as a collective assignment- which was initially sequentially.
so technically i completed my part at one pr and then only assigned myself with another. [assuming the previous was approved - which wasnt]
let me know further. i am willing to drop the prs as requested by the team
cc: @taniandjerry

Understandable! The review coming late was due to the extended weekend. I apologize for that, and understand wanting PRs reviewed asap! The team will always make sure to review within a 24-48 hour period on weekdays, while weekend PRs will result in a 48 hour minimum wait time ahead of review. In addition to any changes that may be requested. Just sharing for your reference!

But as you mentioned, since your PRs weren't reviewed before you self-assigned other recipe submissions, the feedback you were waiting for one PR could have been used in upcoming submissions. Waiting to take on another issue allows you to both make sure your contributions in progress are up to standard, and eliminates you taking opportunity away from community members.

For now, since I want your contributions to still count, while also taking into account the rules being dismissed at the time, what I will do is combine your recipe submissions into one PR, then unassign you from the others. And going forward, allow other contributors to submit recipes and maybe you can focus on other open issues that are open and will open this week. How does that sound?

as i said, i am here to contribute and not give less quality prs or compete etc. i surely accept this.

thank you so much @taniandjerry

[taniandjerry]

For this PR, in addition to Ian's comments, if you merge add this recipe #5129 into this PR and remove the memory extension from both recipes, we will accept this as a "large" weighted-PR. @ARYPROGRAMMER

[taniandjerry]

Oops omg, I didn't mean to delete your comment! But we can approve this PR as is and keep it "medium," then save that recipe for a future submission if you'd like. Thank you!

[taniandjerry]

I have updated everything for you, so you don't have anything to do other than address any final changes here or in #5131 if anything comes up cc @iandouglas

[ARYPROGRAMMER]

this is also ready for review, let me know if all my issues are completed after this merge

[taniandjerry]

#5121

I don't believe I see all the changes Ian requested to this recipe, @ARYPROGRAMMER. After ensuring you have resolved all changes asked for, then we can do another review to help get this merged.

@iandouglas may also have additional comments, but is also traveling and will be delayed in replies. Thank you for reviewing the feedback and applying it to your recipe in the meantime!

[ARYPROGRAMMER]

#5121

I don't believe I see all the changes Ian requested to this recipe, @ARYPROGRAMMER. After ensuring you have resolved all changes asked for, then we can do another review to help get this merged.

@iandouglas may also have additional comments, but is also traveling and will be delayed in replies. Thank you for reviewing the feedback and applying it to your recipe in the meantime!

surely let me track down all things once again

[github-actions]

✅ Recipe Validation Passed

Your recipe(s) are valid and ready for review!

🔍 Next Steps:

1. Our team will review your recipe
2. If approved, we'll run a security scan
3. Once merged, you'll receive $10 in OpenRouter credits (if email provided)

Thanks for contributing to the goose Recipe Cookbook! 🎉

[github-actions]

🔍 Recipe Security Scan Results

✅ Status: APPROVED - All recipes passed security scan

📊 Scan Summary:

• Total recipes scanned: 1

📋 Individual Recipe Results:
✅ Recipe 1: APPROVED (LOW risk)

🔗 View detailed scan results in the workflow artifacts.

[ARYPROGRAMMER]

now i see, i wanted to tell something before removing it completely,

i fixed the thing that was concerning @iandouglas and added more strict behaviour, the thing thats concerning me still is the usage of memory extension for large context handling. conducting previous recipe tests i still believe it could handle a good amount of context and new md files might just be an overhead. moreover there must be another clever way of solving this within the limits of memory extension if thats the case, anyhow currently it works as per your ideas to store patterns in repository files (.goosehints, AGENTS.md, DOCS_GUIDELINES.md)

one cool thing to do would be to create a new system extension for larger context management which can maybe do the same repetitive task of internal md creation in goose-session. just an idea though, if some issue like this exists - i'll be glad to take it up

thanks and most likely now its ready for review

[iandouglas]

@ARYPROGRAMMER one thing I've done in my own goose memory setup is having a memory that says things like

# python standards development formatting linting api cli
If I ask Goose to help me read/write any kind of Python code, 
I want Goose to open and read the file "/path/to/python_standards.txt" 
for rules on how to do so.

this way, that VERY short memory goes to the LLM, and the LLM ill respond back to goose to say "hey, Ian does want Python, go get that file and send it to me, too" if it thinks it's doing Python work, otherwise it'll ignore that memory.

[ARYPROGRAMMER]

@ARYPROGRAMMER one thing I've done in my own goose memory setup is having a memory that says things like

# python standards development formatting linting api cli
If I ask Goose to help me read/write any kind of Python code, 
I want Goose to open and read the file "/path/to/python_standards.txt" 
for rules on how to do so.

this way, that VERY short memory goes to the LLM, and the LLM ill respond back to goose to say "hey, Ian does want Python, go get that file and send it to me, too" if it thinks it's doing Python work, otherwise it'll ignore that memory.

Clever solution for usage, looks to me like similar to curssorrules and stuff but can there be a standard in future [fixed and common] so it's common globally, even curssorrules has a repo wide available file.

[ARYPROGRAMMER]

@taniandjerry , let me know if i can work on any other issue after this, you can directly assign me some large (if recipe) one. hope your consolidation of prs is correct

thanks again

[taniandjerry]

@taniandjerry , let me know if i can work on any other issue after this, you can directly assign me some large (if recipe) one. hope your consolidation of prs is correct

thanks again

Thank you for addressing feedback! I have consolidated and updated weights according to what I shared before. Thank you so much again! While you can't work on another recipe this week, I did tag you in an open video, along with blog post or other issues you can check out in this search