Skip to main content

Assigned Docflows

Docflows allows technical writers to review, edit, and assign automated documentation suggestions generated directly from engineering activity - a Pull Request or a Jira ticket. See Manage Docflows for how a suggestion is generated and reviewed before it reaches this queue.

View Your Assigned Queue​

To see your workload for a specific release, click View Assigned Docflows on the Project Dashboard.

This opens a queue displaying:

  • Source PR & Target File: Links back to the original engineering pull request and displays the destination file path.
  • Batch Updates: If the AI detected that multiple files need updating (e.g., creating a new Markdown file and updating the navigation menu), it will be clearly marked with a 📦 BATCH UPDATE badge.
  • Review Status: A ✓ IA + Editor Reviewed badge means the automated review found no blocking issues. A ⚠️ Editor Flagged Open Issues badge means it didn't fully resolve everything on its own - hover the badge for what's still open, and give those specific files a closer read before pushing. See Manage Docflows for how this review works.
  • Product Tag: The category tag assigned during triage.
  • Screenshot Status: If a preview environment screenshot capture failed or was unreachable, a ⚠️ No Screenshots alert badge is displayed on the dashboard suggestion card.

Review & Push Workflow​

Click Review & Push on any item to open the interactive editor modal. This interface allows you to finalize the content before it merges into your docs repository:

  • Select Target Repo: Choose the specific documentation repository where this update should be published.
  • Review File Actions: For batch updates, you will see a list of all affected files, each tagged with their respective action (e.g., ✨ CREATE for new files or ✏️ UPDATE for existing ones).
  • Draft Editor: Manually refine the AI-generated content inside the text area, in whatever format the file uses (Markdown, reStructuredText, AsciiDoc, HTML, MDX, or DITA XML). You can save your progress at any time by clicking Save Draft.
  • Screenshot Previews: Captured screenshot files are rendered in the modal as read-only image previews rather than plain text blocks. You can view the actual visual rendering of the route directly alongside your text-based documentation updates. SudoDocs pushes these visual assets using standard base64 encoding, automatically committing them under /docs/images/ in the destination repository when you click Push PR.

Manage Engineering Changes​

If an engineer pushes new commits to their Pull Request after the AI has already generated your documentation draft, you do not need to start over:

  • Sync Latest Code: Click this button to fetch the newest code changes from GitHub. The AI will use GraphRAG to analyze the delta and automatically append a ### 🔄 Latest Engineering Updates section to the bottom of your editor, summarizing the missing details without overwriting your manual edits. This button only appears for PR-sourced suggestions - a Jira-sourced one has no linked commits to sync from.

Finalize the Update​

  • Push PR: Once you are satisfied with the draft, click Push PR. SudoDocs will automatically create a new branch, commit your edited files, and open a Pull Request directly in your documentation repository.
  • Dismiss: If the documentation update is no longer relevant to this release, click Dismiss to permanently remove it from your project's assigned list.