Skip to content

Commit cdc173a

Browse files
authored
Revise command examples and documentation guidelines
Removed examples section and updated documentation notes.
1 parent d7ea1fb commit cdc173a

File tree

1 file changed

+6
-12
lines changed

1 file changed

+6
-12
lines changed

agents.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,6 @@ export class MyCommandCommand extends ApifyCommand<typeof MyCommandCommand> {
3838

3939
static override description = "Description of what this command does";
4040

41-
static override examples = [
42-
"$ apify my-command",
43-
"$ apify my-command --flag value"
44-
];
45-
4641
static override args = {
4742
// Define arguments here using Args.*
4843
};
@@ -88,7 +83,7 @@ Study these existing commands for patterns and best practices:
8883

8984
### Error Handling
9085

91-
- Use appropriate error codes from `src/lib/consts.ts`
86+
- Use appropriate exit error codes from `src/lib/consts.ts`
9287
- Provide helpful error messages to users
9388
- Handle edge cases gracefully
9489

@@ -107,16 +102,15 @@ Study these existing commands for patterns and best practices:
107102
## Development Workflow
108103

109104
1. Install dependencies: `yarn install`
110-
2. Run in development mode: `yarn dev:apify` or `yarn dev:actor`
111-
3. Lint code: `yarn lint` or `yarn lint:fix`
112-
4. Format code: `yarn format` or `yarn format:fix`
113-
5. Build project: `yarn build`
114-
6. Run tests: `yarn test:local` or `yarn test:all`
105+
2. Lint code: `yarn lint` or `yarn lint:fix`
106+
3. Format code: `yarn format` or `yarn format:fix`
107+
4. Build project: `yarn build`
108+
5. Run tests: `yarn test:local` or `yarn test:all`
115109

116110
## Important Notes
117111

118112
- Always prompt users for required information if not provided
119113
- Follow the established patterns for command structure and organization
120114
- When in doubt about command type (apify vs actor), ask for clarification
121115
- Maintain backward compatibility when possible
122-
- Update documentation when adding new commands
116+
- Do NOT override the documentation when adding new commands, as it is automatically generated

0 commit comments

Comments
 (0)