docs: batch 6 — leftover audit items (FAQ link, gateway-config ref, Matrix E2EE, phone examples) - #82182
Open
ewardGPT wants to merge 1 commit into
Open
docs: batch 6 — leftover audit items (FAQ link, gateway-config ref, Matrix E2EE, phone examples)#82182ewardGPT wants to merge 1 commit into
ewardGPT wants to merge 1 commit into
Conversation
…atrix E2EE, phones) Sixth batch from the docs audit — remaining low-priority items, all verified. - faq.md: Python Library guide link pointed at features/code-execution.md (documents the execute_code tool, not the AIAgent library API) -> now guides/python-library.md (verified file exists). - slash-commands.md: "~/.hermes/gateway-config.yaml" -> config.yaml — that file exists nowhere else in the docs; every platform page uses config.yaml. - matrix.md: E2EE troubleshooting still told users to set legacy MATRIX_ENCRYPTION=true as the primary fix; now points at MATRIX_E2EE_MODE (required) with the legacy var noted as back-compat. - signal.md: replaced invalid +0987654321 example number with valid fictional E.164 (+15550123456,+15550987654). - Masked phone sweep re-applied to this upstream-based branch (4 files) — this branch predates the batch-5 sweep; added fix-masked-phones.py here too. Verified: python-library.md exists at the new path; rate_limit default 30/min in code matches the docs; webhook env-var table complete (rate_limit / max_body_bytes are config keys, correctly documented in the Security section).
alt-glitch
added
type/docs
Collaborator
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
2 participants
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
Sixth batch from the full docs audit (all 200 pages, 142 findings). Independent of PR #82150 (batches 1-4) and #82174 (batch 5) — this branch was cut from upstream/main.
Changes (8 files, +49/-9)
features/code-execution.md(documents theexecute_codetool, not theAIAgentlibrary API) → nowguides/python-library.md(verified the file exists at that path).~/.hermes/gateway-config.yaml→config.yaml. That filename appears nowhere else in the docs; every platform page usesconfig.yamlfor theextra:block.MATRIX_ENCRYPTION=trueas the primary fix — nowMATRIX_E2EE_MODE=required(the current knob) with the legacy var noted as back-compat.+0987654321with valid fictional E.164 numbers.fix-masked-phones.pyhere too.Verification
python-library.mdexists at the new path;rate_limitdefault 30/min verified ingateway/platforms/webhook.py(docs already correct — no change needed there).