docs: Add workflow management documentation page #51
Conversation
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
![promptless[bot]](https://avatars.githubusercontent.com/in/979718?s=80&v=4){kind=small}
promptless
bot
requested review from
adit-chandra,
frances720,
mattlink and
prithvi2206
as code owners
frances720
reviewed
Aug 1, 2025
| description: Learn how to manage documentation suggestions through assignment, labeling, and filtering to streamline team collaboration | ||
| --- | ||
|
|
||
| Promptless provides powerful workflow management features that help teams organize, track, and collaborate on documentation suggestions. These tools make it easier to manage documentation updates across team members and coordinate releases. |
There was a problem hiding this comment.
Suggested change
| Promptless provides powerful workflow management features that help teams organize, track, and collaborate on documentation suggestions. These tools make it easier to manage documentation updates across team members and coordinate releases. | |
| Promptless provides workflow management features that help teams organize, track, and collaborate on documentation suggestions. These tools make it easier to coordinate releases and manage the doc review process among writers, engineers, and subject-matter experts. |
|
|
||
| ## Suggestion Assignment | ||
|
|
||
| You can assign specific suggestions to team members for review and approval. This helps distribute documentation work and ensures the right people are reviewing relevant changes. |
There was a problem hiding this comment.
Suggested change
| You can assign specific suggestions to team members for review and approval. This helps distribute documentation work and ensures the right people are reviewing relevant changes. | |
| You can assign specific suggestions to team members for review and approval. |
|
|
||
| <Steps> | ||
| <Step title="Assign a Suggestion"> | ||
| Navigate to the suggestion you want to assign and select a team member from the assignee dropdown. The assigned team member will be notified and can see all suggestions assigned to them. |
There was a problem hiding this comment.
@prithvi2206 Is this true? (can also check but tagging you to simulate collaborartion. ) also this is a good example of what the citation feature can solve - figuring out if a specific detail in the doc updates is rooted in code
|
|
||
| ## Labeling System | ||
|
|
||
| Labels help categorize and organize suggestions based on their purpose, priority, or target release. This makes it easier to track different types of documentation updates. |
There was a problem hiding this comment.
Suggested change
| Labels help categorize and organize suggestions based on their purpose, priority, or target release. This makes it easier to track different types of documentation updates. | |
| Labels can help organize suggestions based on their project area, priority, or target release. You can add multiple labels to a suggestion. |
| </Card> | ||
| </CardGroup> | ||
|
|
||
| ### Managing Labels |
| </Accordion> | ||
| </AccordionGroup> | ||
|
|
||
| ### Smart Filtering |
There was a problem hiding this comment.
This is dumb, please remove this subsection
| - **Clear Results**: Filtered views clearly show which criteria are applied | ||
| - **Persistent Filters**: Your filter preferences are remembered across sessions | ||
|
|
||
| ## Team Collaboration Benefits |
There was a problem hiding this comment.
This is so dumb. Please remove
| Clear assignment and labeling create accountability and make it easy to track who is responsible for each documentation update. | ||
| </Success> | ||
|
|
||
| ## Best Practices |
|
I've added the requested changes in commit 53c67a3 |
|
@Promptless - all of the links in this page don't work, can you fix them? You should look at docs.yml file for the right paths, if you're not sure, look at other docs with working links |
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.
Creates a comprehensive guide explaining Promptless's workflow management features including suggestion assignment, labeling, and filtering capabilities to help teams collaborate effectively on documentation updates.
Trigger Events
If you want Promptless to make further changes on this PR, feel free to leave a comment tagging Promptless (It won't show up in the user drop down but Promptless will get it!)