Skip to content

Conversation

@ARYPROGRAMMER
Copy link
Contributor

Summary

Intermediate prompt that uses GitHub and Developer extensions to extract inline documentation from repositories and convert it into structured site-ready markdown. Automates migration from code comments to organized documentation with proper formatting and navigation.

Extensions

1. GitHub (External MCP)

  • Type: external (npx -y @modelcontextprotocol/server-github)
  • Env: GITHUB_PERSONAL_ACCESS_TOKEN (required)
  • Purpose: Analyze repos, fetch files, parse inline docs
  • Used for: Reading repo structure, extracting doc content
  • Integration: Supplies raw data to Developer extension

2. Developer (Builtin)

  • Type: builtin (developer)
  • Purpose: Generate, format, and organize markdown files
  • Used for: Creating structured docs and navigation
  • Integration: Converts GitHub data into site-ready docs

Type of Change

  • Feature
  • Documentation

Testing

Validated JSON and 2-extension flow (GitHub → Developer).
Test Command:

goose run -i test-doc-migrator.txt

test-doc-migrator.txt:

Analyze a GitHub repo and generate docs:
1. Scan structure
2. Extract README, comments, function docs
3. Organize into: Getting Started, API Reference, Architecture
4. Output structured markdown

Use Case
Automates documentation migration, ensures consistency, reduces manual effort, and keeps code and docs in sync.

Related Issues
Fixes #4996

Email: [email protected]

@ARYPROGRAMMER ARYPROGRAMMER requested a review from a team as a code owner October 7, 2025 10:59
@iandouglas iandouglas self-requested a review October 7, 2025 19:13
@iandouglas iandouglas added the hacktoberfest Issues awarding points for Hacktoberfest 2025! label Oct 7, 2025
@ARYPROGRAMMER
Copy link
Contributor Author

ARYPROGRAMMER commented Oct 8, 2025

can this be completed today? nothing much complex. thanks.

@iandouglas iandouglas merged commit fc7836d into block:main Oct 8, 2025
11 checks passed
@alexhancock alexhancock mentioned this pull request Oct 9, 2025
michaelneale added a commit that referenced this pull request Oct 9, 2025
* main: (170 commits)
  Applied server side call to parse and save recipe (#5022)
  feat(prompt-library): add Code Documentation Migrator intermediate prompt (#4996) (#5051)
  Add Messy Column Fixer recipe (#5062)
  Cleanup temp files (#5081)
  add openmetadata recipe (#5076)
  Fix Hacktoberfest Leaderboard (#5080)
  adding brand guidelines to AGENTS.md (#4887)
  Fix: Prevent cross-contamination of cache data across analysis modes for `analyze` tool (#5075)
  fix: remove circular reference (#5018)
  Introduced a new prompt for content amplification that integrates multi-step workflows using official Goose extensions. Closes Issue #4998 (#5050)
  Add hint for focus mode when used on file paths for `analyze` tool (#5069)
  fix: use dynamic port allocation for OAuth server (#5019)
  Art vandelay: Import & Export (#5053)
  docs: misc updates for extensions directory (#5035)
  updating recipe scanner workflows for detecting recipes from forked repos (#5056)
  feat(prompt-library): add Smart Meeting Assistant advanced prompt (#4998) (#5031)
  Allow auto focus and typing while chat is initializing (#5043)
  docs(blog): Add blog for running Goose in containerized envs  (#5052)
  fix: Add WINDOWS_CODESIGN_CERTIFICATE to nightly workflow (#5037)
  Developer `analyze` tool improvement (#5030)
  ...
tlongwell-block added a commit that referenced this pull request Oct 10, 2025
* origin/main:
  Improve Rust analysis output for `analyze` tool (#5072)
  Remove duplicate prepare_reply_context call (#5063)
  install react dev tools in development (#4979)
  Doc: Added powershell installation link to the guide (#5012)
  draft of new blog post about automating more automation (#5038)
  Subagent extension selection behavior fix (#5093)
  Add dev and alpha environment indicator (#5092)
  docs: add content carousel (#5086)
  Applied server side call to parse and save recipe (#5022)
  feat(prompt-library): add Code Documentation Migrator intermediate prompt (#4996) (#5051)
  Add Messy Column Fixer recipe (#5062)
  Cleanup temp files (#5081)
  add openmetadata recipe (#5076)
  Fix Hacktoberfest Leaderboard (#5080)
  adding brand guidelines to AGENTS.md (#4887)
  Fix: Prevent cross-contamination of cache data across analysis modes for `analyze` tool (#5075)
  fix: remove circular reference (#5018)
  Introduced a new prompt for content amplification that integrates multi-step workflows using official Goose extensions. Closes Issue #4998 (#5050)
  Add hint for focus mode when used on file paths for `analyze` tool (#5069)
  fix: use dynamic port allocation for OAuth server (#5019)
@taniandjerry taniandjerry added the medium Weight label for Hacktoberfest 2025 issues label Oct 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

hacktoberfest Issues awarding points for Hacktoberfest 2025! hacktoberfest-accepted medium Weight label for Hacktoberfest 2025 issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

💡 Intermediate Prompt Submission #2

3 participants