Commit Graph

12 Commits

Author SHA1 Message Date
mintlify[bot] 9acc34baa8 Update from code changes: agent page awareness across dashboard (#7307)
* docs: editor agent knows dashboard product pages, not just settings

* docs: split long sentence in agent page awareness note

* Apply suggestion from @ethanpalm

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2026-09-09 16:52:14 -07:00
mintlify[bot] 58b245e59f Documentation quality check: fix prerequisite and clarity gaps (#7252)
* docs: fix quality gaps in CLI, automations, editor, and Index pages

* docs: mirror quality fixes into es, fr, zh translations

* Apply suggestion from @ethanpalm

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2026-09-08 09:55:33 -07:00
mintlify[bot] c4e1288bd0 Update from code changes: Ask agent on dashboard settings pages (#7275)
* docs: note Ask agent availability on dashboard settings pages

* docs: shorten es and fr agent page descriptions for SEO

* docs: note agent uses current settings screen as context

* Apply suggestion from @ethanpalm

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2026-09-08 09:50:17 -07:00
mintlify[bot] bd5ce7c5f5 Documentation quality check: fix stale UI claims and gaps (#7236)
* docs: fix stale UI claims and gaps found in quality check

* docs: mirror quality-check fixes into es, fr, zh translations

* Apply suggestion from @ethanpalm

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2026-09-03 08:58:05 -07:00
Ethan Palm 480429f635 Automations UI refresh (#7228)
* copy edit for new UI

* UI changes
2026-09-02 16:07:07 -07:00
Ethan Palm 9a4ec7b557 Editor docs overhaul (#7112)
* Fix editor docs accuracy, split media page, clear translation orphans

Accuracy fixes, each verified against mintlify/mint or mintlify/server:

- pages.mdx: "Editors and managers can restore them" -> "admins".
  "Manager" is not a Mintlify role.
- index.mdx: publishing on a feature branch does not automatically open a
  pull request; you choose commit-to-branch or PR. Contradicted the
  branching page's own table.
- branching-and-publishing.mdx: preview deployments build when you open a
  pull request, not on every branch save. Confirmed in gitlabWebhooks
  (handleMergeRequestOpenEvent) and cruxWebhooks (keyed on reviewId).
  tutorial.mdx was already correct.
- settings.mdx: rewritten against editor-settings-form.tsx. The panel has
  four sections, not "two layers", and the entire Appearance section was
  undocumented - including "Open live preview in new tab", which
  live-preview.mdx already linked readers to. Corrected three setting
  labels, noted that draft PRs default to on, added the 20,000-character
  instruction limit.
- live-preview.mdx: link now resolves to /editor/settings#appearance.

De-bloat:

- Split the media section out of pages.mdx (172 lines, 15 subtopics) into
  editor/media.mdx and added it to the nav.
- Trimmed index.mdx from 11 sidebar-duplicating cards to 4.

Translation orphans and redirects:

- Deleted 7 translated files whose English source was removed in April and
  June. The translate automation never cleaned them up, and in PR #6062 it
  wrote into es|fr|zh/editor/media.mdx 34 days after the English source was
  deleted.
- Dropped /editor/media -> /editor/pages so it stops shadowing the
  recreated page.
- Added /{es,fr,zh}/editor/publish, completing an English-only redirect.
- Added /editor/collaborate and its language variants. That page was
  deleted in June with no redirect and has been a live 404 since.

mint broken-links clean, mint a11y clean, vale 0/0/0 on changed files.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

* Restructure editor docs: 14 pages to 9, cut UI description

The editor section had grown to 14 pages, about 40% of which described
things a user can see on screen. The ratio was 105 field-enumeration
bullets to 42 procedural steps.

New structure, organized around what is invisible rather than what is
on screen:

  Overview      absorbs git-essentials (concepts + the Git mapping table)
  Tutorial      unchanged
  Edit content  absorbs media and navigation
  Publish       branch mechanics, conflicts, git sync, commit signing
  Review        previews, pull requests, approve and merge
  Collaborate   comments + suggestions + real-time editing
  Editor agent  trimmed
  Settings      absorbs configurations as a pointer
  Keyboard shortcuts  unchanged

Removed: git-essentials, media, navigation, live-preview, comments,
suggestions, configurations, branching-and-publishing. Added: publish,
review, collaborate.

configurations.mdx was the clearest cut. It was a 193-line field-by-field
mirror of the Site configurations panel, which is a third rendering of
information already in the docs.json schema and in organize/settings-*
(2,694 lines). It is now a short section in settings.mdx covering only
what is specific to editing configuration from the editor: real-time
sync, the SVG logo constraint, and the redirects interface.

Also cut: block actions, the minimap, code block options, right-click
menu enumerations, page settings field lists (already delegated to
/organize/pages), and most screenshots of self-evident controls.

1,320 to 848 body lines. Field-enumeration bullets 105 to 29.

English redirects added for all eight removed pages. Language variants
deliberately omitted: es/fr/zh still carry the old structure, so
redirecting those paths now would shadow pages that still exist there.
The translation automation should mirror this restructure; verify
afterward that no orphans remain.

Vale vocabulary widened rather than reworded around: autocommit(s|ed|ing)?,
autosav(e|es|ed|ing), dotfile(s)?.

mint broken-links clean, mint a11y clean, vale 0 errors on editor/.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

* Correct keyboard shortcuts against the editor keymap

Verified every documented shortcut against the bindings in mintlify/mint
rather than inferring them. The app-level set is exhaustive:
mod+backslash, mod+i, mod+k, mod+s, mod+shift+period, mod+z, shift+mod+d,
shift+mod+s. Visual-mode bindings come from the Tiptap extensions.

- Cmd/Ctrl+Shift+F ("Switch between Navigation and Files tree") does not
  exist. No such binding is registered anywhere in the dashboard. Replaced
  with the real binding at that spot in the UI: Cmd/Ctrl+Shift+. toggles
  "Show all files".
- Added Heading 5 and Heading 6. Heading.configure sets levels 1-6 and
  preserves the parent Mod-Alt-N shortcuts; the table stopped at 4.
- Added Cmd/Ctrl+G for accordion group, bound in Accordions.tsx.

Confirmed correct and unchanged: Cmd+K search, Cmd+I agent, Cmd+Shift+S
mode toggle, Cmd+Shift+D diff, Cmd+\ sidebar, Cmd+Shift+M comment,
Cmd+Shift+E suggesting mode, Cmd+Shift+X strikethrough, Cmd+K link,
Cmd+Enter line break, Cmd+Shift+8 unordered list, and that source mode
runs Monaco.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

* Document auto publish, drop the deprecated deploy branch lock

Auto publish is available to all deployments, so the settings panel shows
"Auto publish" rather than "Main branch autocommits". It is not just a
rename: when it is on, the editor hides the branch selector and the
Publish button entirely (TopBar returns null for both), so there is no
pending state and no review step. Documented that behavior in
settings.mdx and added a note at the top of publish.mdx, since that page
otherwise assumes a publish step exists.

The deployment branch lock was deprecated and removed, so it stays out of
the docs. It was already dropped from settings.mdx in the restructure.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

* 💅

* copy edit index

* Fix editor docs I verified against dead code

Three claims traced to code that never mounts. Ethan confirmed the diff
shortcut does not work, which exposed the pattern.

- Removed Cmd/Ctrl+Shift+D for diff view. It is registered only at
  SubBar/index.tsx:488, inside EditorSubBar, which is exported and
  imported by nothing. There is no live diff shortcut; exitDiff exists
  only as an onClick in EditorModeContextMenu.
- Source mode runs CodeMirror, not Monaco. SourceEditor resolves through
  source-editor/index.tsx to editor-view.tsx, which imports
  @codemirror/state and @codemirror/view. Monaco is used only by
  EmbedModal. The shortcut rows themselves were correct: CodeMirror's
  defaultKeymap and searchKeymap match VS Code for toggle comment, move
  line, duplicate line, find, and add cursor above/below, all confirmed
  against @codemirror/commands.
- Rewrote the left panel section of pages.mdx. The tabs are Home and
  Publishing (EditorNavigationSidebarContents.tsx:62), not Navigation and
  Files. The Navigation/Files switcher lives in the same dead SubBar
  component. Home renders the workspace file tree including private
  pages; Publishing renders the site navigation and site settings.
  Confirmed by the e2e helper openPublishingNavigation, which queries the
  Publishing tab by role against the running app.

Also corrected in that section: the tree hides docs.json, dotfiles,
extensionless files, all-caps Markdown, and css/js/jsx/mjs/cjs/pdf unless
Show all files is on; "unlisted" was an invented term, replaced with a
link to /organize/hidden-pages; and the folder menu item is "New page",
confirmed by e2e, not "New file".

Added four source-mode bindings that are real and undocumented: Cmd+B and
Cmd+I insert Markdown markers, Cmd+Option+Shift+[ and ] fold and unfold
all.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

* copy edit pages

* copy edit publish

* copy edit review

* copy edit settings

* copy edit collaborate

* Updated mintlify pages

- Updated quickstart.mdx

Mintlify-Source: dashboard-editor

* copy edit keyboard shortcuts

* Updated mintlify pages

- Updated quickstart.mdx

Mintlify-Source: dashboard-editor

* Revert "Updated mintlify pages"

This reverts commit 8d1b50cbfc.

* Updated mintlify pages

- Updated quickstart.mdx

Mintlify-Source: dashboard-editor

* fix editor edits

* Mirror the editor restructure into es, fr, and zh

Brings all three translated sites onto the same nine-page structure as
English instead of waiting for the translate automation, which has a
documented history of leaving orphans behind.

Content:
- Deleted 21 orphans: branching-and-publishing, comments, configurations,
  git-essentials, live-preview, navigation, and suggestions in each
  language. None had an English source after the restructure.
- Added publish, review, and collaborate in each language.
- Rewrote index, pages, settings, agent, and keyboard-shortcuts to match
  the current English content, including Home/Publishing tabs, CodeMirror
  source mode, Show all files, and the restored Appearance section.
- Kept the existing conventions: es uses usted, fr uses vous, keywords and
  product UI labels stay in English, and every heading is wrapped in a
  <div id="english-slug"> so cross-language anchors resolve. Verified that
  every English anchor exists in all three languages.

Navigation and redirects:
- es.json, fr.json, and zh.json now list the same nine pages as docs.json.
- Removed six locale redirects that would have shadowed the new publish
  and collaborate pages once they existed.
- Added 21 locale redirects for the removed pages and retargeted the
  destinations that pointed at them.
- Retargeted four /editor/configurations redirects that pointed at
  #site-configurations, an anchor dropped in the settings rewrite.
- Rewrote stale links in changelog, authentication-setup, concepts, and
  glossary across all three languages, since broken-links does not follow
  redirects.

English fixes needed first, all caused by the settings restructure:
- Restored ## Appearance. Two pages link to #appearance, and its four
  preferences were otherwise undocumented.
- Restored ## Create draft pull requests by default, which changelog
  links to and which defaults to on.
- Promoted Main branch autocommits from ### to ##; it was nested under PR
  instructions, and its warning named a setting no longer on the page.
- Retargeted publish.mdx from the removed #auto-publish anchor.
- Fixed a missing space in the settings page intro.

mint broken-links clean, mint a11y clean (1042 files), vale 0 errors,
all five JSON files valid.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-08-25 19:40:14 -07:00
mintlify[bot] ffae94f58e docs: document SVG attachment size limit for editor agent (#7097)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-08-25 11:44:13 -07:00
mintlify[bot] 448c70439f docs: apply brand tone and writing style fixes to editor/agent.mdx (#6926)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-08-10 11:37:52 -07:00
Ethan Palm 168c7db359 add comments/suggestions (#6924) 2026-08-10 11:34:24 -07:00
Ethan Palm 017d7c7377 Fix Vale warnings (#6378)
* fix: reduce Vale false positives via vocab and config updates

- Make English-word vocab entries case-insensitive so sentence-start
  capitalization and normal prose usage stop flagging (agents, rest,
  cursor, setup, endpoints, etc.)
- Add vocab entries for filenames and code identifiers that appear in
  frontmatter and JSX contexts (docs.json, llms.txt, CLAUDE.md, etc.)
- Ignore openapi frontmatter lines, filenames, JSX attributes, email
  addresses, and internal link targets via TokenIgnores
- Skip inline code scope and indented code fences
- Add Headings exceptions for proper nouns (Claude Code, GitHub
  Actions, Route 53, GA4, etc.)
- Disable linting for the all-code vercel-json-generator snippet

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix: resolve all Vale warnings and errors across docs

Content fixes:
- Reword sentences using 'will', first person, spaced em dashes,
  'e.g.', Latin abbreviations, and hyphenated adverbs
- Sentence-case headings that started with dotted filenames
- Backtick literal API values instead of bolding them
- Move periods inside quotation marks
- Fix Oxford comma rule misfires by restructuring sentences

False-positive suppression:
- Vale toggles around example user questions, keyboard shortcut keys
  (Cmd+I), UI labels, and code samples in JSX contexts that Vale
  misparses
- Exclude vale toggle comments from the brace Token/BlockIgnores so
  in-document commands actually reach Vale (the greedy brace pattern
  was also silently swallowing large regions; now lazy)
- Vocab entries for code identifiers (internal_id, handleSubmit, etc.)
- Per-file rule disables for component docs with dotted JSX names and
  files where link-target linting ignores in-document toggles

Result: vale --minAlertLevel warning is clean repo-wide; only
suggestion-level items (Passive, Semicolons, Acronyms) remain.
mint broken-links passes.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix: correct WordList rule instead of degrading prose

- Restore sentence-start "Email" in advanced-support; the rule now
  only flags hyphenated e-mail/E-mail forms
- Restore the idiom "above all else"; the above->preceding swap now
  exempts "above all"

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix: restore deliberate prose flagged by blunt rules

- Restore spatial 'above the navbar' / 'above a page title' in
  custom-scripts; the above->preceding swap now exempts 'above
  the/a/an'
- Restore the '= ...' in the react-components named-export example
  (the ellipsis is inside inline code) with an Ellipses toggle
- Restore SLA phrasing 'will use commercially reasonable efforts'
  with a Will toggle
- Restore the quoted developer question in the GEO guide intro with a
  FirstPerson toggle, matching the file's other example questions

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix: remove WordList swaps that flag legitimate English

- Drop tablet->device and firewalls->firewall rules; both words are
  correct in ordinary prose
- Narrow touch->tap to UI-instruction phrasing (touch the/a) so
  'keep in touch' and 'touch devices' stop flagging

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix: reposition vale toggles to wrap whole blocks

Toggle comments placed between list items split the lists (restarting
ol numbering in deployments) and comments flush against tables risked
breaking GFM table parsing. Wrap entire lists/tables with blank-line
separation instead. Verified rendering with mint dev: single ol with
two items, tables intact, no comments in visible DOM.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* refactor: prune accept.txt to load-bearing entries

Empirically removed 166 vocab entries (575 -> 409) whose removal
causes no Vale flags across all 908 English pages: dictionary words
that never needed listing (agents, setup, endpoints, webhooks, yaml),
lowercase entries the speller already accepts, and filename entries
made redundant by inline vale toggles.

Kept every case-enforcing entry (API, JSON, GitHub, ...) so casing
policy is unchanged, plus entries that double as capitalization
exceptions for headings (mcp, md, auth, cursor, txt).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* Update ai/mintlify-mcp.mdx

* Update api/agent/v2/create-agent-job.mdx

* chore: alphabetize Headings exceptions and accept.txt

Case-insensitive sort, ignoring the (?i) prefix; also drops a
duplicate Scala entry.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix: re-apply OxfordComma rewrite lost in branch merge

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* docs: resolve Vale suggestions batch 1 (acronyms, semicolons, passive voice)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* docs: resolve remaining Vale suggestions (passive voice batch 2)

Rewrite ~90 passive constructions to active voice across deploy,
guides, migration-services, and organize docs. Toggle the deliberate
passive examples in the style-and-tone guide ('by zombies' test).
Add axios/lodash vocab entries for a repositioned code example.

vale . is now fully clean: 0 errors, 0 warnings, 0 suggestions.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-07-02 17:17:56 -07:00
Ethan Palm 82a3c612da Continue automations in editor (#6261)
* docs: document workflow-to-editor continuation feature

Add documentation for the ability to open automation run changes
directly in the editor, with the editor agent receiving full context
on what the automation did.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* 💅

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-24 13:57:58 -07:00
Ethan Palm 0b777ec048 Editor UI updates and ask agent (#6176)
* Update index.mdx

* add images

* update tutorial

* Update git-essentials.mdx

* Update pages.mdx

* Update branching-and-publishing.mdx

* Update keyboard-shortcuts.mdx

* Update live-preview.mdx

* Create agent.mdx

* Update docs.json

* remove orphaned pages

* Update settings.mdx

* Update pages.mdx

* 💅

* update configurations
2026-06-14 14:17:56 -07:00