docs: update README with latest features and correct repo URL - #43
Open
anoop2811 wants to merge 7 commits into
Open
docs: update README with latest features and correct repo URL#43anoop2811 wants to merge 7 commits into
anoop2811 wants to merge 7 commits into
Conversation
- Add new features: multi-team support, dimension matrix view, survey autosave, session timeout UX, SSO, org hierarchy tree - Update cadence-driven assessment periods documentation - Fix clone URL from anthropics to guidewire-oss - Update survey workflow to reflect multi-team and autosave
There was a problem hiding this comment.
Pull request overview
Updates the root README to reflect newer product capabilities, adjusted assessment-period behavior, corrected repository clone URL, and expanded API endpoint documentation.
Changes:
- Expanded “Key Features” and user workflow documentation (multi-team selector, autosave, session-timeout UX, matrix view, org tree).
- Updated assessment period documentation to be cadence-driven (with examples/table).
- Corrected
git cloneURL and added/expanded listed API endpoints (auth, health checks, admin settings, etc.).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
1 issue found across 1 file
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="README.md">
<violation number="1" location="README.md:27">
P2: The new cadence documentation is out of sync with the app: weekly/biweekly are not supported, and the period examples do not match the formats the code generates.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
Address PR review feedback: - Replace weekly/biweekly with half-yearly/yearly to match supported cadences - Update period format examples to match actual output (YYYY Mon, YYYY QN, etc.) - Fix autosave banner text to match actual UI wording
There was a problem hiding this comment.
1 issue found across 1 file (changes from recent commits).
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="README.md">
<violation number="1" location="README.md:27">
P2: Update the other cadence references too; this change now contradicts the setup section, which still tells admins to use Weekly/Biweekly even though the app only supports monthly/quarterly/half-yearly/yearly.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
Add paths-ignore for markdown files, docs/, LICENSE, and issue/PR templates so documentation-only PRs don't trigger unnecessary builds.
There was a problem hiding this comment.
1 issue found across 1 file (changes from recent commits).
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name=".github/workflows/ci.yml">
<violation number="1" location=".github/workflows/ci.yml:8">
P1: Avoid `paths-ignore` on the `pull_request` trigger; docs-only PRs can leave the required CI check pending instead of reporting a skipped/success status.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
Update setup section and best practices to use the supported cadence values: monthly, quarterly, half-yearly, yearly.
Remove paths-ignore from pull_request trigger so ci-success always reports a status (needed if branch protection is added later). Instead, the Detect Changes job skips all build/test/E2E jobs for docs-only PRs while ci-success still reports success.
There was a problem hiding this comment.
1 issue found across 1 file (changes from recent commits).
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name=".github/workflows/ci.yml">
<violation number="1" location=".github/workflows/ci.yml:328">
P1: Fail the workflow when `changes` fails instead of treating an unset `needs_build` output as a docs-only change.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
Comment on lines
+328
to
+331
| if [[ "$NEEDS_BUILD" != "true" ]]; then | ||
| echo "Docs-only change — all builds skipped. CI passed!" | ||
| exit 0 | ||
| fi |
There was a problem hiding this comment.
P1: Fail the workflow when changes fails instead of treating an unset needs_build output as a docs-only change.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At .github/workflows/ci.yml, line 328:
<comment>Fail the workflow when `changes` fails instead of treating an unset `needs_build` output as a docs-only change.</comment>
<file context>
@@ -316,18 +318,25 @@ jobs:
run: |
+ # For docs-only PRs, all build jobs are skipped — that's OK
+ NEEDS_BUILD="${{ needs.changes.outputs.needs_build }}"
+ if [[ "$NEEDS_BUILD" != "true" ]]; then
+ echo "Docs-only change — all builds skipped. CI passed!"
+ exit 0
</file context>
Suggested change
| if [[ "$NEEDS_BUILD" != "true" ]]; then | |
| echo "Docs-only change — all builds skipped. CI passed!" | |
| exit 0 | |
| fi | |
| if [[ "${{ needs.changes.result }}" != "success" ]]; then | |
| echo "Change detection failed" | |
| exit 1 | |
| fi | |
| if [[ "$NEEDS_BUILD" != "true" ]]; then | |
| echo "Docs-only change — all builds skipped. CI passed!" | |
| exit 0 | |
| fi |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
anthropics/teams360toguidewire-oss/teams360Test plan
Summary by cubic
Updated README to document new Team360 features, cadence-driven assessment periods, and expanded API/admin endpoints; fixed the repo URL. CI now uses change detection to skip builds/tests for docs-only changes while still reporting status.
New Features
APP_ENV=demo.Bug Fixes
Written for commit d65e2a2. Summary will update on new commits.