DocScribe scans a complete codebase and auto-generates a fully-navigable Markdown documentation site that mirrors your folder structure.

Features:

• DocscribeJobSetup – captures run context and validates inputs.
• ProjectLocationResolver – clones or downloads the target project.
• BuildCodeTree – walks the repo and builds an include/exclude filtered file queue.
• FileParser – extracts classes, functions, comments, and signatures from each file.
• DocscribeMarkdownGenerator – drafts Markdown pages with GPT-4.
• DocscribeWriter – writes docs to disk, commits, and opens a pull request.

How to Use:

1. Click the Deploy on WaveAssist button below.
2. Configure required variables:
   docscribe_file_queue, pull_request_url, docscribe_write_log, docscribe_page_fragments, output_path, project_location, docscribe_render_context, docscribe_parsed_units, include_patterns, local_repo_path, OPENAI_API_KEY, job_inputs, documentation_style, exclude_patterns, run_context_ts, docscribe_code_tree, github_access_token.
3. Run the nodes in order:
   • docscribe_job_setup – DocscribeJobSetup
   • project_location_resolver – ProjectLocationResolver
   • build_code_tree – BuildCodeTree
   • file_parser – FileParser
   • docscribe_markdown_generator – DocscribeMarkdownGenerator
   • docscribe_writer – DocscribeWriter
4. Confirm the workflow executes successfully.

---

Repo URL: Coming soon Loom Demo: Coming soon