Skip to content

add reporting guide #187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Jan 3, 2025
Merged
Prev Previous commit
Next Next commit
pnpm run lint:fix
  • Loading branch information
alexcoderabbitai committed Jan 3, 2025
commit 63920773578530dbed7b0c7141580358c17f5d01
3 changes: 3 additions & 0 deletions docs/guides/custom-reports.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,16 +170,19 @@ Provide:
## Best Practices

1. **Be Specific**

- Clearly define what should be included/excluded
- Use precise language to avoid ambiguity
- Specify exact metrics you want to track

2. **Structure Matters**

- Start with high-level summaries
- Use consistent grouping patterns
- Include clear section breaks

3. **Keep it Relevant**

- Focus on actionable information
- Avoid redundant data points
- Consider your audience's needs
Expand Down
3 changes: 2 additions & 1 deletion docs/guides/scheduled-reports.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ The schedule configuration allows you to set precise timing for your reports:
#### Frequency Options

- **Days of Week**

- Select any combination of days (Sun-Sat)
- Set frequency (every 1-3 weeks)
- Ideal for weekly team syncs or sprint reviews
Expand Down Expand Up @@ -67,7 +68,7 @@ Each parameter can be:
- Added or removed as needed
- Combined with other parameters for precise filtering
- Modified using different operators
:::
:::

### Report Content

Expand Down
Loading