Add comprehensive developer documentation and MCP server#1
Open
ibrahimozkn wants to merge 1 commit into
Open
Conversation
Replace the placeholder development page with 39 MDX documentation pages covering the full StudyU architecture, domain model, setup guides, and API references. Add MCP server plugin to expose docs to AI agents, and Mermaid theme for diagram rendering. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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.
Summary
docs/06-development/replacing the placeholder "check our GitHub" pagedocusaurus-plugin-mcp-server) to expose documentation to AI agents via Model Context Protocol@docusaurus/theme-mermaid) for rendering architecture and flow diagramsDocumentation Structure
Configuration Changes
docusaurus.config.js:markdown: { mermaid: true }andthemes: ['@docusaurus/theme-mermaid']docusaurus-plugin-mcp-serverplugin (server name:studyu-docs)trailingSlash: false→true(required for MCP plugin route discovery)package.json: Addeddocusaurus-plugin-mcp-serverand@docusaurus/theme-mermaiddependenciesMCP Server
The MCP plugin generates search artifacts at build time in
build/mcp/:docs.json— 73 indexed documents (all docs pages)search-index.json— FlexSearch index for full-text searchmanifest.json— Build metadataAI agents can use the
docs_searchanddocs_fetchMCP tools to query the documentation programmatically.Build Verification
npm run buildpasses cleanly for both EN and DE localesnpx docusaurus-mcp-verifypasses all checks (73 documents indexed)Breaking Change Note
trailingSlashchanged fromfalsetotrue. This means URLs change from/docs/overviewto/docs/overview/. Docusaurus handles redirects for this, but any hardcoded external links to the old URL format should be verified.Test plan
npm run build— verify clean buildnpm run serve— verify docs render with Mermaid diagramsnpx docusaurus-mcp-verify— verify MCP artifacts🤖 Generated with Claude Code