Add wiki documentation generator for Java components#175
Draft
Add wiki documentation generator for Java components#175
Conversation
…enerator Implements a JavaParser-based documentation generator that: - Scans all project modules for Java source files - Extracts component details (description, code examples, @SInCE, @author, @see) - Generates Markdown wiki pages (one per component) - Creates Home.md index and _Sidebar.md navigation - Includes version compatibility and Spring profiles information - Adds GitHub Actions workflow for automated wiki publishing Co-authored-by: mercyblitz <533114+mercyblitz@users.noreply.github.com> Agent-Logs-Url: https://github.com/microsphere-projects/microsphere-spring/sessions/cf4566dc-192c-41bf-8954-314811735c58
Co-authored-by: mercyblitz <533114+mercyblitz@users.noreply.github.com> Agent-Logs-Url: https://github.com/microsphere-projects/microsphere-spring/sessions/cf4566dc-192c-41bf-8954-314811735c58
|
Copilot
AI
changed the title
[WIP] Add documentation generation for Java components
Add wiki documentation generator for Java components
Mar 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.


Adds a JavaParser-based documentation generator that produces GitHub Wiki pages (one per public Java component) with detailed descriptions, code examples, version compatibility, and
@sinceversion extracted from source.New module:
microsphere-spring-doc-generatorJavaSourceParser— Parses all module source trees using JavaParser (Java 17 language level). Extracts Javadoc,@since,@author,@see, code examples from<pre>{@code}blocks (with raw comment fallback for curly-brace truncation), public method signatures, type hierarchy. Handles implicit public on interface methods.MarkdownRenderer— Renders each component as a Markdown wiki page: overview table, cleaned description (HTML→Markdown), code examples (extracted or auto-generated per component type), public API, version compatibility matrix, see-also references.WikiDocGenerator— Orchestrator scanning all 8 project modules, producing per-component pages +Home.mdindex +_Sidebar.mdnavigation. Entry point:java -jar microsphere-spring-doc-generator.jar <projectRoot> <outputDir>.JavaComponentInfo— Data carrier for extracted component metadata.GitHub Actions workflow:
generate-wiki-docs.ymlTriggers on push to
main(when**/src/main/java/**changes) orworkflow_dispatch. Builds the generator, runs it, and pushes output to the project's wiki repository.Usage
Generated page structure per component:
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
maven.aliyun.com/usr/bin/wget wget --quiet REDACTED -O /tmp/tmp.1sLwdyIrq6/apache-maven-3.9.9-bin.zip g/microsphere-spring-web/src ===" && ls -la /home/REDACTED/work/microsphere-spring/microsphere-sprbash(dns block)/usr/bin/wget wget --quiet REDACTED -O /tmp/tmp.m4sLdZE3xE/apache-maven-3.9.9-bin.zip(dns block)If you need me to access, download, or install something from one of these locations, you can either:
📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.