ideal@soul:~

Tips

#Documentation

Documentation 태그가 붙은 응용프로그램 팁입니다.

2 tips tagged #Documentation, 1-2 showing
1 / 1
Source available preview
Unknown

OpenWiki는 GitHub 저장소를 소스 인용 위키로 바꿔주는 Vercel/eve...

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

macOS / LinuxWinOS
  • 공개 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을 전제로 한다.
  • public deployment는 private repository를 의도적으로 거부하며, `GITHUB_TOKEN`은 공개 repo API rate limit 완화...
  • 조사 시점 기준 release/tag와 LICENSE 파일이 없으므로, 실제 서비스/재배포에는 license 확인과 비용·rate-limit·공개 repo 범위 설정...
AI AgentsDocumentationGitHubNext.jsVercelKnowledge Base
vercel-labs/openwikiSource
Open source format
MIT

AGENTS.md는 AI 코딩 에이전트에게 프로젝트 규칙을 전달하는 공용 README다

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

macOS / LinuxWinOS
  • AGENTS.md는 README.md를 대체하는 문서가 아니라, AI 코딩 에이전트가 읽을 빌드·테스트·코딩 규칙을 별도 Markdown 파일로 분리하는 관례다.
  • 공식 사이트는 60k개 이상 공개 프로젝트 사용 사례를 연결하고, 저장소는 MIT 라이선스의 `agentsmd/agents.md`로 공개되어 있다.
  • 정해진 YAML 스키마가 아니라 일반 Markdown이므로 팀이 실제로 쓰는 명령, 검증 순서, 보안 주의사항, PR 규칙을 짧고 실행 가능하게 적는 것이 핵심이다.
  • 루트 파일 하나로 시작하되, 모노레포에서는 하위 패키지별 `AGENTS.md`를 둘 수 있고 충돌 시 사용자 지시와 가장 가까운 파일의 우선순위를 의식해야 한다.
  • 외부에서 가져온 AGENTS.md는 곧 에이전트 행동 지침이 되므로, 숨은 명령·토큰 요구·파괴적 명령·불필요한 권한 상승을 검토한 뒤 커밋해야 한다.
AI AgentsDeveloper ToolsMarkdownDocumentation
agentsmd/agents.mdSource