Repository navigation
docs: sync roadmap with actual codebase state - #95
Merged
Merged
Conversation
The roadmap described "6 implemented services" and a "prove the thesis on AWS" Phase 1 premise that is long past — the repo has 101 services (`make stats`) with deep coverage, working cross-service integrations, and a plugin system. - Reframe Phase 1 as "AWS Depth & Stabilization" with accurate checkboxes (stub reduction, compat edge cases, stable ServicePlugin API remain open) - Mark 0.x as the current version line in the version-mapping table - De-rot volatile numbers: point at `make test-compat` instead of the stale 671/699 count; fix every "96 services" -> 101 across README and docs Phases 2-4 (multi-CSP prep, Azure pilot, breadth) left intact. Docs-only; no changie fragment (matches prior docs-sync PR #52).
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideUpdates project documentation to accurately reflect the current AWS service coverage, compatibility status, and roadmap focus, and replaces hardcoded metrics with instructions to derive them from File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- You’ve removed most hardcoded counts, but the explicit
~96%phrasing and the list of remaining edge cases (e.g., S3Tables ARN parsing, ServerlessRepojsonName) may still rot; consider either generalizing this wording or tying it to an automated doc generation step so it stays current.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- You’ve removed most hardcoded counts, but the explicit `~96%` phrasing and the list of remaining edge cases (e.g., S3Tables ARN parsing, ServerlessRepo `jsonName`) may still rot; consider either generalizing this wording or tying it to an automated doc generation step so it stays current.
## Individual Comments
### Comment 1
<location path="docs/faq.md" line_range="32" />
<code_context>
### Which services are supported?
-96 AWS services are scaffolded and routed; coverage depth varies. See [services-matrix.md](services-matrix.md) for the canonical list and per-service operation counts. Core services (S3, SQS, DynamoDB, Lambda, IAM, STS, SNS, CloudWatch, KMS, SecretsManager, EventBridge, CloudFormation) pass 100% of their boto3 compatibility tests.
+101 AWS services are scaffolded and routed; coverage depth varies. See [services-matrix.md](services-matrix.md) for the canonical list and per-service operation counts. Core services (S3, SQS, DynamoDB, Lambda, IAM, STS, SNS, CloudWatch, KMS, SecretsManager, EventBridge, CloudFormation) pass 100% of their boto3 compatibility tests.
### Does DevCloud work on Windows?
</code_context>
<issue_to_address>
**nitpick (typo):** Consider spelling the service name as "Secrets Manager" for consistency.
Elsewhere in these docs (e.g., the Phase 1 roadmap bullet), this service is written as "Secrets Manager". Updating this instance from "SecretsManager" to "Secrets Manager" will match AWS’s official name and keep the docs consistent.
```suggestion
101 AWS services are scaffolded and routed; coverage depth varies. See [services-matrix.md](services-matrix.md) for the canonical list and per-service operation counts. Core services (S3, SQS, DynamoDB, Lambda, IAM, STS, SNS, CloudWatch, KMS, Secrets Manager, EventBridge, CloudFormation) pass 100% of their boto3 compatibility tests.
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
…ording - Spell "Secrets Manager" (was "SecretsManager") in faq.md and services-matrix.md, matching AWS's name and the roadmap bullet - Roadmap: drop redundant "~96%" from the ≥95% checkbox (the checkbox already asserts the milestone) and generalize the named edge-case bug list, which would go stale as those bugs are fixed - faq.md: tie the ~96% figure to `make test-compat` so it reads as a refreshable snapshot
Earlier pass softened some numbers but left contradicting hard-coded ones: - services-matrix.md header: 4,451 -> 4,460 (matches `make stats`), 96% -> ~96% (matches the softened pass-rate line below it); refresh note now points at `make test-compat` for the compat figure, not just `make stats` - services-matrix.md: drop the exact "28 failures" count (contradicted ~96%) - README.md: state operations as a "4,400+" floor so it can't drift - roadmap.md: don't mark all extended-tier coverage done — claim core + integration + *major* extended, and scope stub reduction to less-common operations plus scaffolded services
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.
Why
docs/roadmap.mdwas badly out of sync with the codebase and misrepresented the project to anyone who read it first:make stats): 101 services, ~4,460 operations, with deep hand-written coverage well beyond the "Big 6", working cross-service integrations, and aServicePluginplugin system.671/699 passing(now 717 compat tests); README/docs said 96 services (actual 101).What changed
docs/roadmap.md— Phase 1 reframed to "AWS Depth & Stabilization" with accurate checkboxes (stub reduction, compat edge cases, stableServicePluginAPI remain open); version-mapping table marks0.x ← current. Phases 2–4 (multi-CSP prep, Azure pilot, breadth) left intact — still accurate future work matchingarchitecture.md.README.md,docs/README.md,docs/configuration.md,docs/faq.md,docs/services-matrix.md— pass-count now points atmake test-compatinstead of a frozen number; every "96 services" → 101.Numbers reference
make stats/make test-compatrather than baked-in values so they can't drift again.Verification
make stats→ 101 / 4,460 (matches the "100+" wording)grep -rn "671/699\|96 services" README.md docs/→ no matches[x]integration claim backed by an existing file (cloudformation/engine.go,lambda/eventsource.go,s3/notifications.go)Docs-only; no Changie fragment (matches prior docs-sync PR #52).