Skip to content

Website#22

Merged
ichiriac merged 7 commits into
mainfrom
website
Jan 17, 2026
Merged

Website#22
ichiriac merged 7 commits into
mainfrom
website

Conversation

@ichiriac

Copy link
Copy Markdown
Owner

This pull request delivers a comprehensive overhaul and improvement of the NormalJS documentation, focusing on clarity, accuracy, and usability for both developers and AI coding agents. The changes correct previously misleading patterns, introduce a task-oriented and example-rich structure, and reorganize navigation for better discoverability and learning progression.

Documentation Corrections:

  • Corrected all documentation to show the proper NormalJS pattern for updating records: direct property modification instead of non-existent update() or save() methods, with explicit anti-pattern warnings and updated examples across all major docs.
  • Updated all relevant files (.github/copilot-instructions.md, docs/index.md, docs/cookbook.md, docs/models.md) to remove incorrect usage and demonstrate the correct way to update, persist, and delete records.

Documentation Improvements:

  • Enhanced documentation structure to be task-oriented and pattern-based, providing "How to" guides, DO/DON'T examples, complete runnable code, error prevention, and improved searchability with keywords and a reorganized sidebar.
  • Expanded and improved .github/copilot-instructions.md, docs/index.md, docs/cookbook.md, and docs/models.md with richer examples, anti-patterns, and practical guidance for both developers and AI agents.
  • Added migration guide keywords and improved discoverability for the Sequelize adoption guide.

Navigation and Organization:

  • Reorganized the documentation sidebar in docs/assets/sidebars.js to introduce new categories (Getting Started, Core Concepts, Working with Data, Advanced Patterns, Reference, Migration Guides), improving logical flow and progressive learning.
  • Moved and categorized the Sequelize adoption guide under "Migration Guides" for easier access.

Content Updates and Consistency:

  • Overhauled docs/index.md to provide a detailed, step-by-step quick start, key features, common tasks, and advanced topics, ensuring all examples reflect the corrected patterns and best practices.
  • Updated cross-references and links in documentation to reflect new file names and organization, ensuring consistency and ease of navigation.

Meta and Infrastructure:

  • Updated the GitHub edit URL in docusaurus.config.js to reflect the new repository location.

These improvements ensure that both human developers and AI agents will follow the correct, idiomatic NormalJS patterns, avoid common pitfalls, and quickly find the information they need.

Change deployment branch from master to website
- Expanded the index.md file to include key features, quick start guide, and common tasks with detailed examples.
- Updated models.md with comprehensive model reference, including guidelines for defining fields, relations, querying, and lifecycle hooks.
- Added best practices for model definitions, including do's and don'ts, and improved examples for creating, updating, and deleting records.
- Included new sections on computed properties, lifecycle hooks, and indexes with examples for better clarity and usability.
@ichiriac ichiriac merged commit 9fc8417 into main Jan 17, 2026
4 checks passed
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