mirror of
https://github.com/bitsocialnet/5chan.git
synced 2026-08-03 07:41:04 +02:00
Tommaso Casaburi
2088c4b50d
Corrects the react-doctor PR-check command and workflow filename, marks the superseded hooks-tarball surprises now that bitsocial-react-hooks comes from npm, rewrites hooks-setup.md around the real per-harness entry points and drops its drifted inline script copies, points the Task Router translations row at the translate skill, and adds a committed skills/subagents index so agents can discover the tooling that already exists.
51 lines
4.4 KiB
Plaintext
51 lines
4.4 KiB
Plaintext
# 5chan
|
|
|
|
> 5chan is a static, serverless, adminless, decentralized imageboard client built on the Bitsocial protocol.
|
|
|
|
This file is generated by `scripts/generate-llms-files.mjs`. Do not hand-edit it; update the source docs or generator config, then run `yarn llms:generate`.
|
|
|
|
## Canonical Links
|
|
|
|
- [App](https://5chan.app)
|
|
- [Repository](https://github.com/bitsocialnet/5chan)
|
|
- [Releases](https://github.com/bitsocialnet/5chan/releases/latest)
|
|
- [Bitsocial protocol](https://bitsocial.net)
|
|
- [5chan Board Manager](https://github.com/bitsocialnet/5chan-board-manager)
|
|
- [Directory list source](https://github.com/bitsocialnet/lists/blob/master/5chan-directories.json)
|
|
- [llms-full.txt](https://5chan.app/llms-full.txt): Expanded inline corpus generated from the curated source docs.
|
|
|
|
## Critical Context
|
|
|
|
- 5chan.app serves a static client shell, not board or thread content.
|
|
- User-generated board content is fetched client-side from Bitsocial boards and peer-to-peer infrastructure.
|
|
- Board owners host and moderate their own content; the app operator does not run a central content backend.
|
|
- Do not describe Vercel, a CDN, or the 5chan.app origin as serving user-generated board or thread content.
|
|
- Do not propose SSR or server rewrites for board/thread URLs unless a maintainer explicitly asks for that tradeoff.
|
|
- Hash routing and static deployment compatibility are intentional product and liability choices.
|
|
- Preferred framing: static client, decentralized imageboard client, serverless/adminless interface.
|
|
- For code contributions, AGENTS.md and directory-specific AGENTS.md files are the source of truth.
|
|
|
|
## Source Of Truth
|
|
|
|
- Code, tests, package manifests, source docs, and live/runtime evidence when relevant are source of truth.
|
|
- This generated file is compiled context for orientation. Verify behavioral claims against source files before editing or concluding.
|
|
- Repo-managed AI instructions live in `AGENTS.md` and any directory-specific `AGENTS.md` files.
|
|
|
|
## Core Documents
|
|
|
|
- [5chan](https://github.com/bitsocialnet/5chan/blob/master/README.md): 5chan is a serverless, adminless, decentralized and open-source imageboard built on the [Bitsocial protocol](https://bitsocial.net). It features the classic imageboard directory structure, but with a crucial differenc...
|
|
- [AGENTS.md](https://github.com/bitsocialnet/5chan/blob/master/AGENTS.md): This file defines the always-on rules for AI agents working on 5chan. Use this as the default policy. Load linked playbooks only when their trigger condition applies.
|
|
- [Product](https://github.com/bitsocialnet/5chan/blob/master/PRODUCT.md): product
|
|
- [Overview](https://github.com/bitsocialnet/5chan/blob/master/DESIGN.md): **Creative North Star: "The Preserved Imageboard"**
|
|
- [src/AGENTS.md](https://github.com/bitsocialnet/5chan/blob/master/src/AGENTS.md): These rules apply to `src/**`. Follow the repo-root `AGENTS.md` first, then use this file for code inside the application source tree.
|
|
- [scripts/AGENTS.md](https://github.com/bitsocialnet/5chan/blob/master/scripts/AGENTS.md): These rules apply to `scripts/**`. Follow the repo-root `AGENTS.md` first, then use this file for automation and workflow helpers.
|
|
- [Known Surprises](https://github.com/bitsocialnet/5chan/blob/master/docs/agent-playbooks/known-surprises.md): This file tracks repository-specific confusion points that caused agent mistakes.
|
|
- [Long-Running Agent Workflow](https://github.com/bitsocialnet/5chan/blob/master/docs/agent-playbooks/long-running-agent-workflow.md): Use this playbook when a task is likely to span multiple sessions, handoffs, or spawned agents.
|
|
- [Bug Investigation Workflow](https://github.com/bitsocialnet/5chan/blob/master/docs/agent-playbooks/bug-investigation.md): Use this when a bug is reported in a specific file/line/code block.
|
|
- [Translations Workflow](https://github.com/bitsocialnet/5chan/blob/master/docs/agent-playbooks/translations.md): This project uses i18next translation files in `public/translations/{lang}/default.json`.
|
|
- [Skills and Tools](https://github.com/bitsocialnet/5chan/blob/master/docs/agent-playbooks/skills-and-tools.md): Use this playbook when setting up/adjusting skills and external tooling, or to discover what is already committed.
|
|
|
|
## Optional
|
|
|
|
- [Upload Automation Retest Checklist](https://github.com/bitsocialnet/5chan/blob/master/docs/upload-automation-retest-checklist.md): Retest checklist for Android and desktop after changes to media upload automation (`MediaUploadAutomationRunner`, `MediaUploadRecipes`, `upload-orchestrator`, etc.).
|