Skip to content

Adjust AGENTS.md and the existing Docs - #409

Open
Bohreromir wants to merge 8 commits into
mainfrom
worktree-docs-361-agents-md
Open

Bohreromir wants to merge 8 commits into
mainfrom
worktree-docs-361-agents-md

Conversation

@Bohreromir

@Bohreromir Bohreromir commented Oct 26, 2026 •

Copy link
Copy Markdown
Member

Description

Updates the AGENTS.md and readme.

closes #361

Docs

Release note

Checklist

Author

  • AI review done, findings addressed
  • Tests added or updated
  • Changelog updated (if the repo keeps one)

Reviewer

  • Useful comments and logging
  • Docs added or updated per the style guide

Acceptance

  • Check for release notes and docs

Fix stale tech stack, structure and setup details, document unit tests, database, feature flags and the rules enforced by ESLint and the architecture tests, and include the accessibility rules from #400.
@github-actions

github-actions Bot commented Oct 26, 2026 •

Copy link
Copy Markdown

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 67.27% 9094 / 13517
🔵 Statements 66.25% 12253 / 18493
🔵 Functions 68.08% 2935 / 4311
🔵 Branches 57.25% 5141 / 8979
File CoverageNo changed files found.
Generated in workflow #1202 for commit 4140df8 by the Vitest Coverage Report Action

@Bohreromir Bohreromir self-assigned this Oct 26, 2026
@Bohreromir
Bohreromir marked this pull request as ready for review October 26, 2026 14:48
@Bohreromir Bohreromir moved this to Development: Waiting for Review in Stackable Engineering Oct 26, 2026
Comment thread README.md
> [!WARNING]
> Stackable Cockpit is experimental.

## About The Stackable Data Platform

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the README can you model it after our other READMEs?

Not all parts fit but they should cross reference each other and point at our commercial offering etc. so something like this needs to stay in.

Adds the Stackable header, SDP intro, About/Other Operators/Support/Sponsor
sections and the shared images from the operator README template.
Updates AGENTS.md for bookmarks in PostgreSQL and the configuration split.
@Bohreromir
Bohreromir requested a review from lfrancke October 29, 2026 13:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Development: Waiting for Review

Development

Successfully merging this pull request may close these issues.

Update Claude/AGENTS.md to reflect current state

2 participants