Skip to content

Implement Ralph Wiggum workflow for SDK documentation generation #1

Description

@joshsmithxrm

Summary

Use the Ralph Wiggum plugin to automate SDK reference documentation generation with iterative refinement.

Background

Ralph Wiggum is a Claude Code plugin for autonomous iteration loops:

  • Claude works on a task
  • Stop hook intercepts when Claude thinks it's "done"
  • Re-feeds prompt, Claude sees modified files
  • Iterates until completion criteria met or max-iterations reached

Use Case

Generate consistent, complete SDK reference docs:

/ralph-loop "Generate reference documentation for all PPDS NuGet packages.

For each package (PPDS.Plugins, PPDS.Migration, PPDS.Dataverse, PPDS.Auth, PPDS.Cli):
1. Read source code in ppds repo
2. Generate Docusaurus-formatted reference doc
3. Include: installation, usage examples, API reference
4. Verify all code examples compile
5. Verify all internal links valid

Completion criteria:
- All 5 packages documented
- npm run build passes
- Output: <promise>DOCS_COMPLETE</promise>
" --max-iterations 30 --completion-promise "DOCS_COMPLETE"

Implementation

  • Install Ralph Wiggum plugin
  • Create /generate-sdk-docs command with Ralph loop
  • Define completion criteria (build passes, links valid, coverage)
  • Test with single package first (PPDS.Plugins)
  • Scale to all packages
  • Document the workflow in CONTRIBUTING

Priority: High

This enables scalable, consistent doc generation.

References

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    Status
    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions