Skip to main content

Repo Launch Checklist

Use this checklist before publicly promoting the repository.

Core release checks

  • CI is passing on main
  • GitHub Pages is live at the public docs URL
  • README badges are loading correctly
  • root README is polished and up to date
  • Docusaurus build succeeds locally

Content and demo readiness

  • screenshots or demo assets are added for the homepage and at least one project
  • at least one demo GIF or screenshot is captured for social sharing
  • completed projects table reflects the current starter status
  • project docs point to the correct starter folders

Open-source readiness

  • LICENSE is present
  • CONTRIBUTING.md is useful
  • CODE_OF_CONDUCT.md is present
  • SECURITY.md is present
  • CHANGELOG.md is updated
  • issue templates and PR template are present

GitHub settings

  • repository description is set
  • repository website points to https://ankitparekh007.github.io/Agentic-Engineering-Playbook/
  • GitHub Pages source is set to GitHub Actions
  • topics are added:
    • ai-agents
    • rag
    • mcp
    • langgraph
    • llm
    • angular
    • typescript
    • agentic-ai
    • ai-copilot
    • playwright
    • docusaurus
  • issues are enabled
  • discussions are optional
  • branch protection on main is optional but recommended

Launch prep

  • first 5 GitHub issues are created and labeled
    • if issue creation is blocked, use docs/open-source/first-issue-drafts.md as the source of truth until manual creation
  • repository description and topics are set
  • LinkedIn launch post is drafted
  • screenshots for the social post are prepared
  • one short repo demo path has been rehearsed

If the labels do not already exist in GitHub, add them before or immediately after opening the first issues:

  • good first issue
  • documentation
  • enhancement
  • project-upgrade
  • help wanted

Nice-to-have follow-up

  • add real screenshots for Project 05
  • add a local browser-smoke screenshot from Project 06
  • create a short walkthrough video or animated GIF
  • tag the first public launch release