Skip to content

Commit 8302d25

Browse files
author
Promptless Agent
committed
Add guidance for documenting platform-wide features across all SDKs
1 parent 6c260f2 commit 8302d25

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

.long_term_context/doc_workflow/client_instructions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
When making updates to documentation about an SDK, you should generally see if similar documentation exists for another SDK, so you can generally follow the patterns in that documentation. Note: this does not mean that if you don't see documenation for that feature for another SDK, you should avoid creating it for this one.
66

7+
**Platform-wide features:** When documenting features that are server-side or platform-wide (such as workflow reset, Web UI functionality, CLI commands, or other operations that work identically across SDKs), consider whether the documentation should be added to all SDK pages rather than just one. These features often don't require SDK-specific code examples and should be consistently documented across all SDKs for discoverability.
8+
79
# Key Terms and Proper Nouns
810

911
Only introduce new proper nouns when really necessary. If you do ever have to introduce a proper noun, you should also include an entry in the glossary at docs/glossary.md to explain that proper noun.

0 commit comments

Comments
 (0)