docs: improve agent-readable project overview

[Tehlikeli107]

Summary

• Replace duplicated template content in the root README with a concise project overview.
• Add contract directory navigation, setup/build commands, and testing caveats.
• Add a root llms.txt file so AI coding agents can quickly find the relevant docs, source directories, and safe contribution guidance.

Verification

• git diff --check HEAD~1 HEAD

Notes

• Docs-only change; no contract behavior changed.

Summary by CodeRabbit

• Documentation
  • Restructured README from template to focused guide covering PotLock Core Contracts, project introduction, contract enumeration, developer prerequisites, installation/build instructions, and resource links.
  • Added AI coding agent navigation guide with contract directories, documentation links, build commands, testing notes, and development best practices.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: cedb17b1-7150-42d8-8839-2add5c5915b8

📥 Commits

Reviewing files that changed from the base of the PR and between 7ffcf91 and d86c39a.

📒 Files selected for processing (2)

• README.md
• llms.txt

---

📝 Walkthrough

Walkthrough

This PR updates the project documentation to clearly guide both human developers and AI agents through the PotLock Core Contracts repository. The README.md is rewritten with contract stack information, concrete developer setup and build instructions, and references to the new llms.txt guide. The new llms.txt file provides AI-specific navigation including contract directories, build commands from the contracts/ root, legacy test caveats, and developer guidance rules.

Changes

Documentation and Developer Guidance

Layer / File(s)	Summary
Project README and AI agent navigation README.md, llms.txt	README replaced with contracts-focused introduction, developer prerequisites, build/test instructions, and link to llms.txt. New llms.txt file documents contract directories, build commands, legacy test notes, and agent guidance for security-sensitive and wasm-related work.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A README reborn, from template to truth—
Contracts unfurled for seasoned codesmith and youth,
AI companions now find their own map,
Through llms.txt, a rabbit-approved gap,
Building and testing in NEAR's sandbox embrace! 🌟

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'docs: improve agent-readable project overview' accurately summarizes the main changes: enhancing documentation (README.md rewrite and new llms.txt) to make the project more accessible to AI agents.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

• Generate code and open pull requests
• Plan features and break down work
• Investigate incidents and troubleshoot customer tickets together
• Automate recurring tasks and respond to alerts with triggers
• Summarize progress and report instantly

Built for teams:

• Shared memory across your entire org—no repeating context
• Per-thread sandboxes to safely plan and execute work
• Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}