docs: add documentation - #6
Merged
Merged
Conversation
Pull request template
Contains contributing rules (branches, commits, PRs).
Remove accidental slash
Correct the projects name: The Scents -> Scent
Write a complete README.md documentation
make relative to the dev branch. Later update to the main
Add a env step to the Getting Started section
update Tech Stack section: reorder things
- Make the 'Responsive' check obligatory only after the Phase 5 is reached - Remove dark mode check (no dark mode design is available)
Add link to the pull_request_template.md file
Add Navigation section
improve with Claude
- update the Navigation section - rename React -> React / Next.js - add `use client usage` h4 section - add `props destructuring` h4 section - add `exports` h3 section - add `folder colocation` h3 section
- add Enum vs Const - add Explicit Return Types - add null vs undefined
- Import Ordering - Absolute vs Relative Imports
- Comment conventions - console.log policy
Mention data.ts to Project Structure
Add title to each screenshot
rename master to main
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
1 participant
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.
Description
In this PR essential documentation for the project was added:
Changes
README.mdCONTRIBUTING.md./docs/images/./docs/code_conventions.md./.github/pull_request_template.mdfilterDropdownScreenshots
Testing
Checked correct documentation visibilty in GitHub.
Checklist