Skip to content

docs(agents): describe the tree as it is now #7

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.

Sign up for GitHub

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
Aswin-V merged 1 commit into from
Nov 9, 2026
Merged

docs(agents): describe the tree as it is now #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 23 additions & 10 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,27 @@
# eSec — agent notes

Placeholder repository (Status: Planned). No implementation, build manifests,
tests, or automation exist on `master` yet. The code that will become eSec
lives in [`embeddedos-org/eos`](https://github.com/embeddedos-org/eos) at
Placeholder repository (Status: Planned). No implementation, build manifests
or tests exist on `master` yet. The repository holds the org security policy
(`SECURITY.md`, `.well-known/security.txt`) and security docs under `docs/`.

@sourcery-ai sourcery-ai Bot Nov 9, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Medium · Security policy is now referenced

AGENTS.md now identifies SECURITY.md as the organization's disclosure policy, contradicting the entry's claim that the file does not exist.

Update the knowledge entry to reflect the current presence of SECURITY.md.

Also at AGENTS.md:33-34.

Prompt for AI agents 
In `AGENTS.md` at line 5:

**Security policy is now referenced**

AGENTS.md now identifies `SECURITY.md` as the organization's disclosure policy, contradicting the entry's claim that the file does not exist.

Update the knowledge entry to reflect the current presence of `SECURITY.md`.

Also at `AGENTS.md:33-34`.

From AGENTS.md L17, AGENTS.md L22:

No `CONTRIBUTING.md` exists. Keep changes scoped and follow the repository's

A docs workflow checks those docs, the README and `security.txt` (not
Comment on lines +4 to +6

@sourcery-ai sourcery-ai Bot Nov 9, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Medium · Docs describe an available CI command

AGENTS.md now says the repository has a docs workflow and names a verified docs-check command, contradicting the entry's claims that there are no workflows or verified commands and that the tree holds only three files.

Update the knowledge entry to reflect the repository's current contents and docs-check workflow.

Also at AGENTS.md:15-18.

Prompt for AI agents 
In `AGENTS.md` at lines 4-6:

**Docs describe an available CI command**

AGENTS.md now says the repository has a docs workflow and names a verified docs-check command, contradicting the entry's claims that there are no workflows or verified commands and that the tree holds only three files.

Update the knowledge entry to reflect the repository's current contents and docs-check workflow.

Also at `AGENTS.md:15-18`.

From AGENTS.md L8-13:

## Build / test / lint

No verified commands exist: the tree holds only `README.md`, `LICENSE`, and
`.gitignore` — no manifest (`package.json`, `pyproject.toml`,
`CMakeLists.txt`), no workflows, no tests, and the README documents no
commands. Do not invent commands; re-check the README before running anything.

`SECURITY.md` or this file). The code that will become eSec lives in
[`embeddedos-org/eos`](https://github.com/embeddedos-org/eos) at
`services/security/` and `services/crypto/`. See [README.md](README.md).

## Build / test / lint

No verified commands exist: the tree holds only `README.md`, `LICENSE`, and
`.gitignore` — no manifest (`package.json`, `pyproject.toml`,
`CMakeLists.txt`), no workflows, no tests, and the README documents no
commands. Do not invent commands; re-check the README before running anything.
There is no build and there are no tests: no manifest (`package.json`,
`pyproject.toml`, `CMakeLists.txt`) and no source code. The one verified
command is the docs check that CI runs (`.github/workflows/ci.yml`):

```sh
python3 ci/check_docs.py
```

It needs only the Python standard library. It checks that each doc under
`docs/` and the README has one H1, that relative links resolve, and that

@sourcery-ai sourcery-ai Bot Nov 9, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚪ Low · Sidebar H1 coverage is overstated

When an agent relies on the stated H1 coverage for docs/wiki/_Sidebar.md, check_h1 exempts docs/wiki/_Sidebar.md, so the check passes even when that file has no H1 and agents get a false validation guarantee.

Document that docs/wiki/_Sidebar.md is exempt from the H1 check.

Prompt for AI agents 
In `AGENTS.md` at line 22:

**Sidebar H1 coverage is overstated**

When an agent relies on the stated H1 coverage for `docs/wiki/_Sidebar.md`, `check_h1` exempts `docs/wiki/_Sidebar.md`, so the check passes even when that file has no H1 and agents get a false validation guarantee.

Document that `docs/wiki/_Sidebar.md` is exempt from the H1 check.

`.well-known/security.txt` has `Contact` and `Expires` and has not expired.
Do not invent other commands.

## Contributing

Expand All @@ -19,9 +30,11 @@ automation and review requirements.

## Security

No `SECURITY.md` exists. Do not report suspected vulnerabilities in public
issues; use GitHub private security advisories or a private org channel.
Background: [docs/wiki/Security.md](docs/wiki/Security.md).
[SECURITY.md](SECURITY.md) is the coordinated vulnerability disclosure policy
for the whole organization; [docs/cvd-intake.md](docs/cvd-intake.md) is the
report template and [.well-known/security.txt](.well-known/security.txt) the
RFC 9116 contact file. Do not report suspected vulnerabilities in public
issues.

## Wiki mirror

Expand Down
Loading