Skip to content

docs: add wiki/SharX-Overview.md#9

Open
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1778528317-wiki-sharx-overview
Open

docs: add wiki/SharX-Overview.md#9
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1778528317-wiki-sharx-overview

Conversation

@devin-ai-integration

Copy link
Copy Markdown

Summary

Adds a new wiki/ folder at the repository root containing SharX-Overview.md, the top-level wiki page mirrored from the Devin-generated wiki ("SharX Overview" page).

The page documents:

  • System Architecture (Hub-and-Spoke Panel + Worker Nodes) with a mermaid component-interaction diagram
  • Key Components (Panel, Worker Nodes, Subscription System)
  • Navigation Map mapping UI features to code entities and GORM data models (mermaid diagram)
  • Technical Specifications table (Go 1.26, Gin, GORM/PostgreSQL, Xray-core, Next.js, sessions/JWT)
  • Wiki Structure index

All "Relevant source files" and inline Sources: references point to existing files in the repo via relative links (e.g. ../README_EN.md, ../web/web.go, ../database/model/model.go).

No code changes — documentation only.

Review & Testing Checklist for Human

  • Open wiki/SharX-Overview.md on GitHub and confirm both mermaid diagrams render correctly
  • Spot-check a few of the relative source-file links (e.g. ../README_EN.md, ../go.mod, ../web/web.go) and confirm they resolve
  • Confirm the section headings match what you expected from the Devin wiki page (System Architecture, Key Components, Navigation Map, Technical Specifications, Wiki Structure)

Notes

The mermaid node IDs from the original wiki used [bracketed labels], which is not valid Mermaid syntax for node IDs. They were rewritten to use valid node IDs with quoted labels (e.g. web_web_go["web/web.go"]) so the diagrams actually render on GitHub. The visual structure and edges/relationships are preserved.

Link to Devin session: https://app.devin.ai/sessions/ee1a52ce60d24502a1f9c1ded4fccf2f
Requested by: @konstpic

@devin-ai-integration

Copy link
Copy Markdown
Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant