Skip to content

docs: refresh README - #764

Merged
setchy merged 1 commit into
mainfrom
docs/refresh-readme
Oct 3, 2026
Merged

setchy merged 1 commit into
mainfrom
docs/refresh-readme

Conversation

@setchy

@setchy setchy commented Oct 3, 2026

Copy link
Copy Markdown
Member

Summary

Rewrite the README from the stale Astro starter template to a lean, contributor-focused document.

  • 🚀 Getting started — prerequisites (Node >= 24, pnpm) + real scripts (install, dev, build, preview, lint)
  • 📝 Content — how FAQ content works: src/faqs/<category>/<slug>.md, frontmatter title / category / order, and the four fixed categories matching CATEGORY_ORDER in src/pages/faq.astro
  • 🤝 Contributing — links the in-site "How to contribute" FAQ and the Code of Conduct
  • 📄 License — MIT

Kept: all five badges and their link labels. Fixed: the license badge pointed at gitify-app/gitify; now gitify-app/website.
Dropped: stale "Project Structure" diagram (referenced a non-existent Logo.astro), generic Astro commands, and the standalone "Made with Astro." line.

@setchy
setchy requested a review from afonsojramos as a code owner October 3, 2026 20:43
@netlify

netlify Bot commented Oct 3, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for gitify ready!

Name Link
🔨 Latest commit 6830c59
🔍 Latest deploy log https://app.netlify.com/projects/gitify/deploys/6ac16906fa35d20008cc2862
😎 Deploy Preview https://deploy-preview-764--gitify.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 93 (🟢 up 2 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@sonarqubecloud

sonarqubecloud Bot commented Oct 3, 2026

Copy link
Copy Markdown

@setchy
setchy merged commit 28823a2 into main Oct 3, 2026
13 checks passed
@setchy
setchy deleted the docs/refresh-readme branch October 3, 2026 20:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant