Skip to content

Commit 682593a

Browse files
committed
add concepts
1 parent 00162d9 commit 682593a

1 file changed

Lines changed: 9 additions & 11 deletions

File tree

β€Ždocs/concepts.mdβ€Ž

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,9 @@ Every agentic workflow has two main parts:
2626

2727
```markdown
2828
---
29-
# Configuration
30-
on: { issues: { types: [opened] } }
31-
permissions: { issues: write }
32-
tools: { github: { allowed: [add_issue_comment] } }
29+
on: ...
30+
permissions: ...
31+
tools: ...
3332
---
3433

3534
# Natural Language Instructions
@@ -57,15 +56,13 @@ GitHub Agentic Workflows enable "Continuous AI" β€” the systematic application o
5756
- **Continuous Research** β€” Stay current with industry developments
5857
- **Continuous Quality** β€” Automated code review and standards enforcement
5958

60-
### πŸ“‚ Available Demonstrator Workflows from "[The Agentics](https://github.com/githubnext/agentics?tab=readme-ov-file#-the-agentics)"
61-
62-
#### Research & Planning Workflows
59+
#### Demonstrator Research & Planning Workflows
6360
- [πŸ“š Weekly Research](https://github.com/githubnext/agentics?tab=readme-ov-file#-weekly-research) - Collect research updates and industry trends
6461
- [πŸ‘₯ Daily Team Status](https://github.com/githubnext/agentics?tab=readme-ov-file#-daily-team-status) - Assess repository activity and create status reports
6562
- [πŸ“‹ Daily Plan](https://github.com/githubnext/agentics?tab=readme-ov-file#-daily-plan) - Update planning issues for team coordination
6663
- [🏷️ Issue Triage](https://github.com/githubnext/agentics?tab=readme-ov-file#️-issue-triage) - Triage issues and pull requests
6764

68-
#### Coding & Development Workflows
65+
#### Demonstrator Coding & Development Workflows
6966
- [πŸ“¦ Daily Dependency Updater](https://github.com/githubnext/agentics?tab=readme-ov-file#-daily-dependency-updater) - Update dependencies and create pull requests
7067
- [πŸ“– Regular Documentation Update](https://github.com/githubnext/agentics?tab=readme-ov-file#-regular-documentation-update) - Update documentation automatically
7168
- [πŸ” Daily QA](https://github.com/githubnext/agentics?tab=readme-ov-file#-daily-qa) - Perform quality assurance tasks
@@ -113,7 +110,7 @@ Learn more in [Tools Configuration](tools.md) and [MCPs](mcps.md).
113110

114111
1. **Start simple** β€” Begin with basic workflows and add complexity gradually
115112
2. **Be specific** β€” Clear, detailed instructions produce better results
116-
3. **Test iteratively** β€” Use `gh aw compile --watch` during development
113+
3. **Test iteratively** β€” Use `gh aw compile --watch` and `gh aw run` during development
117114
4. **Monitor costs** β€” Use `gh aw logs` to track AI usage and optimize
118115
5. **Review outputs** β€” Always verify AI-generated content before merging
119116

@@ -122,7 +119,7 @@ Learn more in [Tools Configuration](tools.md) and [MCPs](mcps.md).
122119
- **Event-driven** β€” Respond to issues, PRs, pushes, etc.
123120
- **Scheduled** β€” Regular maintenance and reporting tasks
124121
- **Alias-triggered** β€” Activated by @mentions in comments
125-
- **Conditional** β€” Use frontmatter logic to control execution
122+
- **Secure** β€” User minimal permissions and protect against untrusted content, see [Security Notes](security-notes.md)
126123

127124
## Next Steps
128125

@@ -131,6 +128,7 @@ Ready to build more sophisticated workflows? Explore:
131128
- **[Workflow Structure](workflow-structure.md)** β€” Detailed file organization and security
132129
- **[Frontmatter Options](frontmatter.md)** β€” Complete configuration reference
133130
- **[Tools Configuration](tools.md)** β€” Available tools and permissions
131+
- **[Security Notes](security-notes.md)** β€” Important security considerations
134132
- **[VS Code Integration](vscode.md)** β€” Enhanced authoring experience
135133

136-
The power of agentic workflows lies in their ability to understand context, make intelligent decisions, and take meaningful actions β€” all while maintaining the security and reliability you expect from GitHub Actions.
134+
The power of agentic workflows lies in their ability to understand context, make intelligent decisions, and take meaningful actions β€” all while maintaining the reliability you expect from GitHub Actions.

0 commit comments

Comments
Β (0)