docs: comprehensive ecosystem documentation for 360Magicians / MBTQ#4
Merged
Merged
Conversation
…, pinksync, mbtquniverse
Copilot created this pull request from a session on behalf of
Pmaster-dev
July 2, 2026 02:12
View session
PR Summary by QodoDocs: consolidate 360Magicians/MBTQ ecosystem guides and expand OpenAPI spec
AI Description
Diagram
High-Level Assessment
Files changed (30)
|
Code Review by Qodo
1. Invalid auth header docs
|
![qodo-code-review[bot]](https://avatars.githubusercontent.com/in/484649?s=60&v=4){kind=small}
Comment on lines
+25
to
+31
| ## Authentication | ||
|
|
||
| Obtain a token from [DeafAUTH](https://deafauth.mbtq.dev/docs) and pass it as a ****** | ||
|
|
||
| ``` | ||
| Authorization: ****** | ||
| ``` |
There was a problem hiding this comment.
1. Invalid auth header docs 🐞 Bug ≡ Correctness
The OpenAPI description and multiple docs instruct clients to send Authorization: ******, which does not match the declared scheme: bearer DeafAUTH security scheme and will lead to invalid requests when copied. The same placeholder also creates effectively blank/misleading auth sections (e.g., empty headings) in rendered Markdown docs.
Agent Prompt
## Issue description
Auth examples are currently shown as `******`, which omits the required Bearer token format and renders poorly in Markdown. This conflicts with the OpenAPI `deafauth` security scheme (`scheme: bearer`) and will cause users to copy/paste invalid headers.
## Issue Context
The OpenAPI spec defines DeafAUTH as a bearer token scheme, but the description and docs show `Authorization: ******` instead of `Authorization: Bearer <token>`.
## Fix Focus Areas
- openapi/openapi.yaml[25-31]
- openapi/openapi.yaml[397-403]
- docs/README.md[103-114]
- docs/projects/deafauth.md[20-28]
## Suggested fix
- Replace `******` placeholders with explicit, copy/paste-safe examples:
- `Authorization: Bearer <DEAFAUTH_TOKEN>`
- In curl: `-H "Authorization: Bearer $DEAFAUTH_TOKEN"`
- Avoid unescaped asterisks in prose/headings; use `<...>` placeholders or backticks.
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
Comment on lines
+241
to
+246
| AI_MODEL_OVERRIDE=llama3 # use local Ollama instead of OpenAI/Gemini | ||
| HF_TOKEN=hf_... # HuggingFace token for serverless inference | ||
| OPENAI_API_KEY=sk-... | ||
| ANTHROPIC_API_KEY=sk-ant-... | ||
| GOOGLE_AI_API_KEY=AIza... | ||
| GROQ_API_KEY=gsk_... |
There was a problem hiding this comment.
2. Secret-like env placeholders 🐞 Bug ⛨ Security
docs/ai-model-manifest.md includes example env vars with real credential prefixes (e.g., sk-..., AIza...), which can be mistaken for real secrets and may trip simplistic secret-scanning or compliance checks. These should be replaced with non-secret-pattern placeholders (e.g., <OPENAI_API_KEY>).
Agent Prompt
## Issue description
The docs include env var examples that match common real API key prefixes (`sk-`, `sk-ant-`, `AIza`, `gsk_`). Even though they contain `...`, they can be confused with actual secrets and may trigger basic secret scanners.
## Issue Context
These values appear in a `.env` example in documentation.
## Fix Focus Areas
- docs/ai-model-manifest.md[239-248]
## Suggested fix
Replace secret-looking samples with safer placeholders that do not match real key formats, e.g.:
- `OPENAI_API_KEY=<OPENAI_API_KEY>`
- `ANTHROPIC_API_KEY=<ANTHROPIC_API_KEY>`
- `GOOGLE_AI_API_KEY=<GOOGLE_AI_API_KEY>`
- `GROQ_API_KEY=<GROQ_API_KEY>`
Optionally add a one-liner: "Never paste real keys into docs; use placeholders."
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
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
Consolidates all documentation added across multiple sessions into a single PR covering the full 360Magicians / MBTQ ecosystem.
New Docs
docs/git-workflow.mddocs/helm.mddocs/providers.mddocs/environments.md.envvar reference, secrets management rules, promotion checklistdocs/package-managers.md/serverdirectory layoutdocs/triggers-webhooks.mddocs/pipeline-handoffs.mddocs/copilot-bots.mddocs/ai-model-manifest.mddocs/ai-inference.mdopenapi/openapi.yamlIndex Updates
docs/README.md— split into Ecosystem Guides + Project Docs sections; linked all new filesREADME.md(root) — same split + new entries linkeddocs/infrastructure.md— minor additions