Repository navigation
docs: add key capabilities to the README, home, and About pages - #308
Merged
Merged
Conversation
Summarize what Kumoss does, how it fits an organization, and what can be brought in (model, OIDC provider, authorization logic, IaC executor) through the OpenAPI contracts. Add a README note on the upcoming MCP and A2A support.
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
Contributor
❗ This Pull Request will not trigger a docs releaseA Pull Request with no |
|
|
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Several capability claims overstate drift remediation, report coverage, model and OIDC compatibility, and sidecar architecture.
3 open findings
What changed in this PR
Adds consistent capability summaries across the repository and documentation landing pages.
Changes:
- Describes infrastructure generation, organizational integration, and customization capabilities.
- Adds linked capability cards to the documentation homepage.
- Notes planned MCP and A2A support.
| File | Description |
|---|---|
README.md |
Adds the capability overview. |
docs/src/modules/ROOT/pages/index.adoc |
Expands homepage capability cards. |
docs/src/modules/main/pages/about.adoc |
Replaces key features with grouped capabilities. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| **What Kumoss does for you** | ||
|
|
||
| - **Compliant infrastructure from plain language.** A developer-friendly assistant needs only your request and the project you are working on. | ||
| - **A validated plan, every time.** Kumoss reads your IaC code and the infrastructure actually deployed in the cloud, then proposes a change that fulfills the request. It treats what is deployed as the source of truth and transparently corrects existing and impacted drift, including day-2 changes. The result is a successful Terraform/OpenTofu plan that complies with the architecture, security, and governance rules your organization defines. |
Comment on lines
+59
to
+63
| .xref:main:guides/generate-infrastructure.adoc[Get a validated, compliant plan] | ||
| Kumoss reads your code and the infrastructure deployed in the cloud, | ||
| treats what is deployed as the source of truth, corrects impacted drift, | ||
| and delivers a successful Terraform or OpenTofu plan that meets your | ||
| organization's standards. |
Comment on lines
+51
to
+54
| * *A validated plan, every time* — Kumoss reads your IaC code and the | ||
| infrastructure deployed in the cloud, treats what is deployed as the | ||
| source of truth, and transparently corrects existing and impacted drift, | ||
| including day-2 changes. The result is a successful Terraform or OpenTofu |
2 of 5 tasks
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
Gives anyone landing on the repository or the documentation site a quick view of what Kumoss can do. The same capability set appears in three places, grouped the same way:
Changes:
README.md: new Key capabilities section, plus a note on upcoming MCP and A2A support.docs/src/modules/ROOT/pages/index.adoc: the home page's Key capabilities block becomes three card grids, each card linking to its guide or reference page.docs/src/modules/main/pages/about.adoc: Key features is replaced by a Key capabilities list with the same grouping.Checklist
git commit -S)Additional context
npx antora antora-playbook.local.ymlbuilds with no warnings, so every new xref resolves.