Skip to content

Add agent docs#557

Merged
aversey merged 3 commits intologicalclocks:mainfrom
aversey:agent
Mar 13, 2026
Merged

Add agent docs#557
aversey merged 3 commits intologicalclocks:mainfrom
aversey:agent

Conversation

@aversey
Copy link
Contributor

@aversey aversey commented Mar 13, 2026

No description provided.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds repository “agent” guidance and Copilot review instructions to standardize how contributors build/lint the Hopsworks docs site and how automated agents should review content.

Changes:

  • Add agent-facing documentation under .agent/ plus a top-level AGENTS.md.
  • Add GitHub Copilot review instructions under .github/.
  • Ignore local Claude agent settings via .gitignore and add CLAUDE.md (as a symlink target pointer).

Reviewed changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
CLAUDE.md Adds a Claude entrypoint that points to the agent instructions.
AGENTS.md Documents local setup/build/lint commands and high-level docs rules.
.gitignore Ignores user-specific local agent settings file.
.github/copilot-instructions.md Defines repo-specific review rules for Copilot (style, nav, linking, code blocks).
.agent/README.md Central agent command reference and docs structure guidance.
.agent/content.md Writing conventions, lint rules, code block and linking rules.
.agent/caveats/README.md Defines caveat format and contribution pattern for caveats.
.agent/caveats/javadoc-stub.md Documents the local javadoc stub workaround for strict MkDocs builds.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

aversey and others added 2 commits March 13, 2026 10:18
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@aversey aversey merged commit 31a23a7 into logicalclocks:main Mar 13, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants