#Documentation Tips

2 tips tagged #Documentation, 1-2 showing

1 / 1

Source available previewUnknown

vercel-labs/openwiki는 공개 GitHub 저장소를 읽어 소스 경로와 citation이 붙은 문서형 wiki를 생성하고, Vercel·Neon·Blob 위에서 온디맨드 생성과 주기적 refresh를 운영하는 Next.js/eve 기반 웹 앱입니다.

공개 GitHub 저장소 URL을 넣으면 README·package metadata·docs·entrypoint 같은 high-signal 파일을 읽어 문서형 out...
Next.js 16 앱에 eve agent를 붙인 구조이며, 저장소 metadata/job/revision/chat state는 Neon Postgres, 생성된 w...
공식 배포 흐름은 Vercel one-click deploy이고, 로컬 개발은 Node 24 이상·pnpm·Vercel env pull을 전제로 한다.

vercel-labs/openwikiSource ↗

Open source formatMIT

AGENTS.md는 README 옆에 두는 표준 Markdown 규칙 파일로, 여러 AI 코딩 에이전트가 빌드·테스트·코딩 규칙을 같은 위치에서 읽게 해준다.

AGENTS.md는 README.md를 대체하는 문서가 아니라, AI 코딩 에이전트가 읽을 빌드·테스트·코딩 규칙을 별도 Markdown 파일로 분리하는 관례다.
공식 사이트는 60k개 이상 공개 프로젝트 사용 사례를 연결하고, 저장소는 MIT 라이선스의 `agentsmd/agents.md`로 공개되어 있다.
정해진 YAML 스키마가 아니라 일반 Markdown이므로 팀이 실제로 쓰는 명령, 검증 순서, 보안 주의사항, PR 규칙을 짧고 실행 가능하게 적는 것이 핵심이다.

agentsmd/agents.mdSource ↗

팁 목록