Problem/Motivation

In order to make sure that AI tools can easily navigate through our small world here we should update the docs folder to allow that.

Proposed resolution

Document the current features with Claude.

Issue fork display_builder-3626867

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

yannickoo created an issue. See original summary.

yannickoo opened merge request !442

yannickoo’s picture

yannickoo
Location Berlin
commented
Status: Active » Needs review
mogtofu33’s picture

mogtofu33 commented
Assigned: Unassigned » mogtofu33

mogtofu33 opened merge request !443

mogtofu33 opened merge request !444

mogtofu33’s picture

mogtofu33 commented
Assigned: mogtofu33 » Unassigned
Issue tags: +AI-accelerated, +display_builder-1.0.0-beta9

Seems better to split in 2: documentation update and part for agents.

For the agents I think we need an entrypoint file, and do not think we need any acceptance criteria or changelog as we have CHANGELOG.md, this will mostly 'rot'.

So my proposition:

3626867-split-1-docs-update: your edits to the 23 existing pages, kept as they are. They fix real errors, the SourceTree rules and the page layout takeover for example. I added four small fixes on top.

3626867-split-2-docs-agents: the agent files, reshaped.

  • They moved out of docs/. Zensical publishes every file in that folder, in the navigation or not, so the specs and the empty template were on the public site and in its search.
  • A root AGENTS.md is the entry point. Without it no tool finds the files.
  • Acceptance Criteria are gone. They restated the tests, and about half of the cited tests do not assert the claim. Out of 480 claims checked, 74 were off. An agent trusts a wrong line more than no line.
  • Changelog sections and their issue links are gone. CHANGELOG.md is generated from the commits by git-cliff. A second copy by hand will drift. Issue links that explain a decision stay in Design Decisions.
  • PRODUCT.md and STANDARDS.md are gone. They repeated index, faq, contributing and tests. Their useful parts are in AGENTS.md, which links to the docs instead of copying them.
  • The FEATURE.md template and the /document-feature comments are gone. That command is not in the repository.

  • mogtofu33 committed df8f802b on 1.0.x 
    task: #3626867 Update docs folder, update

By: yannickoo
By: mogtofu33
mogtofu33’s picture

mogtofu33 commented
Status: Needs review » Fixed

I guess it's good for now to go with that and have follow up issues.

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

  • mogtofu33 committed e061b50a on 1.0.x 
    task: #3626867 Update docs folder for agents

By: yannickoo
By:...