Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
update()orsave()methods, with explicit anti-pattern warnings and updated examples across all major docs..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:
.github/copilot-instructions.md,docs/index.md,docs/cookbook.md, anddocs/models.mdwith richer examples, anti-patterns, and practical guidance for both developers and AI agents.Navigation and Organization:
docs/assets/sidebars.jsto introduce new categories (Getting Started, Core Concepts, Working with Data, Advanced Patterns, Reference, Migration Guides), improving logical flow and progressive learning.Content Updates and Consistency:
docs/index.mdto 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.Meta and Infrastructure:
docusaurus.config.jsto 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.