[README] Improve documentation (2026-02-23)

[nicdavidson]

README Improvements

Automated improvements based on README audit recommendations.

Changes

• Addressed missing sections and structural issues
• Improved code examples and documentation clarity
• Enhanced overall README quality

Audit Summary

README AUDIT: dreamfactorysoftware/df-docs

1. SCORE: 32/100

Justification: A bare-bones Docusaurus boilerplate that tells you how to build the docs site, not what the documentation is about or who should use it. Lacks context, purpose, and developer guidance.

---

2. FIRST IMPRESSION (0-10 seconds)

Grade: D-

A developer landing here sees:

• "This website is built using Docusaurus 3" — okay, but why do I care?
• Installation/deployment commands — assumes I already know this is what I need
• Missing: What is DreamFactory? What does this documentation cover? Who is the audience?

Verdict: No value proposition. No context about the actual product or documentation content.

---

3. STRUCTURE ANALYSIS

Aspect	Status	Notes
Flow	❌ Poor	Jumps from title → tech stack → commands with no introduction
Organization	❌ Weak	Installation/Build/Deployment mixed without clear separation
Clarity	❌ Unclear	No distinction between "contributing to docs" vs "using docs" workflows
Findability	❌ Bad	Single link, no TOC, no navigation hints

Issues:

• "Local Development" and "Build" sections describe the same tooling redundantly
• Deployment section has a broken code block (missing opening ``` before $ GIT_USER...)
• No "What is this?" section before diving into commands

---

4. CODE EXAMPLES

Aspect	Status	Notes
Runnable	✅ Yes	npm install, `npm

---

Generated by Pressroom SEO pipeline

[netlify]

✅ Deploy Preview for dreamfactory-docs ready!

Name	Link
🔨 Latest commit	168438d
🔍 Latest deploy log	https://app.netlify.com/projects/dreamfactory-docs/deploys/699d0b534a0e22000893d08c
😎 Deploy Preview	https://deploy-preview-97--dreamfactory-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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