Skip to content

Update agent docs#383

Open
claudiahaddad wants to merge 9 commits intomasterfrom
update-agent-docs
Open

Update agent docs#383
claudiahaddad wants to merge 9 commits intomasterfrom
update-agent-docs

Conversation

@claudiahaddad
Copy link
Collaborator

@claudiahaddad claudiahaddad commented Sep 23, 2025

  • Removed redundant content & streamlined sidebar navigation
  • More clearly set expectations for agent devs by framing the process as getting feedback, not getting featured.
  • 🗑️ Removed Files
    docs/base-app/agents/best-practices.mdx - Content consolidated into other files
    docs/base-app/agents/why-agents.mdx - Content consolidated into other files
  • ✏️ Updated Files
    docs/base-app/agents/building-quality-agents.mdx - Enhanced with improved content and guidance
    docs/base-app/agents/getting-featured.mdx - Updated with better documentation structure
    docs/docs.json - Fixed sidebar navigation to remove references to deleted files

Uploading Screenshot 2025-09-23 at 2.42.26 PM.png…

- Updated building-quality-agents.mdx with improved content
- Updated getting-featured.mdx with enhanced guidance
- Removed best-practices.mdx and why-agents.mdx (consolidated into other files)
- Removed 'why-agents' and 'best-practices' from Chat Agents navigation
- These files were deleted in previous commit but sidebar still referenced them
@cb-heimdall
Copy link
Collaborator

cb-heimdall commented Sep 23, 2025

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 1/2
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
2 if repo is sensitive 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 1
Sum 2

- Enhanced building-quality-agents.mdx with improved guidance
- Updated chat-agents.mdx with better content structure
- Refined getting-featured.mdx with clearer instructions
- Additional improvements to agent getting featured documentation
- Changed 'Fill out the form [here]' to 'Fill out [this form]' for better readability
youssefea
youssefea previously approved these changes Sep 23, 2025
ericbrown99
ericbrown99 previously approved these changes Sep 23, 2025
@cb-heimdall cb-heimdall dismissed stale reviews from youssefea and ericbrown99 September 23, 2025 23:15

Approved review 3259845242 from youssefea is now dismissed due to new commit. Re-request for approval.

@cb-heimdall
Copy link
Collaborator

Review Error for youssefea @ 2025-09-23 23:21:41 UTC
User cannot review their own commit

ericbrown99
ericbrown99 previously approved these changes Sep 24, 2025
claudiaonchain and others added 3 commits September 26, 2025 13:03
- Add detailed onboarding message structure and examples
- Include group chat etiquette and multi-channel support guidelines
- Expand communication style recommendations
- Add engagement strategies and continuous value creation
- Provide concrete examples of good vs poor practices
@cb-heimdall cb-heimdall dismissed ericbrown99’s stale review September 26, 2025 20:03

Approved review 3260041421 from ericbrown99 is now dismissed due to new commit. Re-request for approval.

@youssefea
Copy link
Contributor

@claudiahaddad we can close this PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants