Conversation
…ggers
Append sections to docs/source/{Eng,Zh}/.../new_features_doc.rst
covering each of the five new features added in PR #184: per-action
profiler with hot-spot view, run history timeline + failure thumbnail
preview, encrypted secret vault and ${secrets.NAME} placeholders,
webhook (HTTP push) trigger, and IMAP email poll trigger. Includes
headless Python usage, AC_* command surfaces, GUI tab summary, and
cross-references to ${webhook.*} / ${email.*} variable bags.
Each toctree carried a :caption: that exactly matched its surrounding H2 section heading, so readthedocs rendered "Getting Started" / "User Guide (English)" / "API Reference" twice. Remove the redundant captions and let the section heading do that work.
Up to standards ✅🟢 Issues
|
|
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
1 participant
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
Doc-only follow-up to PR #184.
docs/source/{Eng,Zh}/.../new_features_doc.rstfor the five features added in Profiler, run-history timeline, secrets, webhook + email triggers, embedder fixes #184 (per-action profiler, run-history timeline + failure thumbnails, encrypted secret manager, webhook trigger, IMAP email trigger). Each section covers headless Python usage, AC_* command surface, the variable bag the trigger seeds (${webhook.*},${email.*},${secrets.NAME}), and the matching GUI tab.:caption:directive on every toctree indocs/source/index.rst. Each caption was identical to its surrounding H2 heading, so the readthedocs homepage rendered "Getting Started" / "User Guide (English)" / "API Reference" twice.No code changes.
Test plan
python -m docutils.parsers.rstparse check on both updatednew_features_doc.rstfiles — only pre-existing Sphinx domain-role warnings (:mod:,:class:,:func:)git diffonindex.rstshows only:caption:line removals, no structural changes