Skip to content

Commit 603845f

Browse files
committed
docs(documentation): Consolidate and simplify documentation structure
- Remove GETTING_STARTED.md and BROWSER_COMPATIBILITY.md files - Update DOCUMENTATION_STRUCTURE.md to reflect new modular approach - Remove outdated comparison and future improvements sections - Simplify README.md by removing redundant documentation links - Remove browser compatibility table reference from README - Update MIGRATION_GUIDE.md to align with new structure - Streamline documentation by consolidating related content into core guides - Improve focus on essential API reference and practical examples
1 parent 0e74279 commit 603845f

File tree

5 files changed

+413
-583
lines changed

5 files changed

+413
-583
lines changed

DOCUMENTATION_STRUCTURE.md

Lines changed: 1 addition & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Documentation Structure
22

3-
This document explains the new documentation structure for React Hook Form AI, designed for easy LLM consumption and better developer experience.
3+
This document explains the documentation structure for React Hook Form AI, designed for easy LLM consumption and better developer experience.
44

55
## Overview
66

@@ -18,11 +18,9 @@ react-hook-form-ai/
1818
├── README.md # Concise overview with links
1919
├── docs/
2020
│ ├── README.md # Documentation index
21-
│ ├── GETTING_STARTED.md # Installation & basic usage
2221
│ ├── API_REFERENCE.md # Complete API documentation
2322
│ ├── PROVIDERS.md # Provider configuration guide
2423
│ ├── EXAMPLES.md # Practical examples
25-
│ ├── BROWSER_COMPATIBILITY.md # Browser requirements
2624
│ └── logo.png # Logo image
2725
├── src/
2826
│ ├── useForm.ts # Enhanced with TSDoc
@@ -106,19 +104,6 @@ react-hook-form-ai/
106104

107105
**Target Audience:** Developers implementing specific features
108106

109-
### docs/BROWSER_COMPATIBILITY.md
110-
111-
**Purpose:** Browser requirements and compatibility
112-
113-
**Content:**
114-
- Chrome AI requirements
115-
- Other provider compatibility
116-
- Fallback strategies
117-
- Mobile support
118-
- Troubleshooting
119-
120-
**Target Audience:** Developers dealing with browser compatibility
121-
122107
## TSDoc Annotations
123108

124109
All public APIs now have comprehensive TSDoc comments:
@@ -232,7 +217,6 @@ Documents link to related content:
232217
```
233218

234219
3. **Update Relevant Guides**
235-
- Add to GETTING_STARTED.md if it's a core feature
236220
- Add to EXAMPLES.md with practical examples
237221
- Update PROVIDERS.md if it affects configuration
238222

@@ -265,41 +249,6 @@ Documents link to related content:
265249
4. **Update version** in documentation
266250
5. **Announce breaking changes** clearly
267251

268-
## Comparison with Old Structure
269-
270-
### Before
271-
272-
- Single large README.md (~1300 lines)
273-
- All content in one file
274-
- Hard to navigate
275-
- Difficult for LLMs to parse
276-
- No auto-generation
277-
278-
### After
279-
280-
- Modular documentation (6 focused files)
281-
- Easy navigation with links
282-
- LLM-friendly structure
283-
- Auto-generated API reference
284-
- Comprehensive examples
285-
286-
## Future Improvements
287-
288-
### Planned
289-
290-
- [ ] Interactive examples with CodeSandbox
291-
- [ ] Video tutorials
292-
- [ ] Migration guide from React Hook Form
293-
- [ ] Performance optimization guide
294-
- [ ] Advanced patterns guide
295-
296-
### Under Consideration
297-
298-
- [ ] Translations (i18n)
299-
- [ ] API playground
300-
- [ ] Visual diagrams
301-
- [ ] Changelog integration
302-
303252
## Feedback
304253

305254
Documentation improvements are always welcome! Please:

README.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -111,11 +111,6 @@ function Root() {
111111

112112
## Documentation
113113

114-
### Getting Started
115-
- 📖 [Getting Started Guide](./docs/GETTING_STARTED.md) - Installation and basic usage
116-
- 🔧 [Provider Configuration](./docs/PROVIDERS.md) - Detailed provider setup
117-
- 🌐 [Browser Compatibility](./docs/BROWSER_COMPATIBILITY.md) - Browser requirements
118-
119114
### API & Examples
120115
- 📚 [API Reference](./docs/API_REFERENCE.md) - Complete API documentation
121116
- 💻 [Examples](./docs/EXAMPLES.md) - Practical usage examples
@@ -245,8 +240,6 @@ See [API Reference](./docs/API_REFERENCE.md) for complete documentation.
245240
| Edge ||||
246241
| Mobile ||||
247242

248-
See [Browser Compatibility](./docs/BROWSER_COMPATIBILITY.md) for details.
249-
250243
## Contributing
251244

252245
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.

docs/BROWSER_COMPATIBILITY.md

Lines changed: 0 additions & 263 deletions
This file was deleted.

0 commit comments

Comments
 (0)