Update Docs for Frontend and sub module #43
Conversation
There was a problem hiding this comment.
Pull request overview
This PR improves the documentation structure for the CourseReview project by reorganizing the setup guide and adding comprehensive frontend setup instructions with git submodule support.
Changes:
- Improved markdown structure with proper section headings (Environment, Backend, Frontend)
- Moved frontend environment setup instructions from backend section to new dedicated Frontend section
- Added two alternative methods for frontend development: git submodule workflow and standalone repository clone
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/setup.md
Outdated
| * Run frontend (dev mode): `cd CourseFront`, run `bun run dev` and visit http://127.0.0.1:5173/ | ||
|
|
||
| ### Set up | ||
| Under frontend(`CourseReview/frontend` or `CourseFront`) directory: |
There was a problem hiding this comment.
Missing space after "frontend" and before the opening parenthesis. Should be "Under frontend (CourseReview/frontend or CourseFront) directory:"
| Under frontend(`CourseReview/frontend` or `CourseFront`) directory: | |
| Under frontend (`CourseReview/frontend` or `CourseFront`) directory: |
docs/setup.md
Outdated
| 14. Run frontend (dev mode): `make dev-frontend` and visit http://127.0.0.1:5173/ | ||
| ## Frontend | ||
| There are two ways of developing/running frontend codes: | ||
| - use git submodule, which registered frontend under the `/frontend` sub directory of `CourseReview` repo: |
There was a problem hiding this comment.
Grammar issue: "which registered" should be "which registers" (present tense) since this describes a current/ongoing state, not a past action.
| - use git submodule, which registered frontend under the `/frontend` sub directory of `CourseReview` repo: | |
| - use git submodule, which registers the frontend under the `/frontend` subdirectory of the `CourseReview` repo: |
docs/setup.md
Outdated
|
|
||
| 14. Run frontend (dev mode): `make dev-frontend` and visit http://127.0.0.1:5173/ | ||
| ## Frontend | ||
| There are two ways of developing/running frontend codes: |
There was a problem hiding this comment.
Minor grammar improvement: "frontend codes" should be "frontend code" (singular) as "code" is typically uncountable in this context.
| There are two ways of developing/running frontend codes: | |
| There are two ways of developing/running frontend code: |
docs/setup.md
Outdated
| * Run frontend (dev mode): `cd CourseReview`, run `make dev-frontend` and visit http://127.0.0.1:5173/ | ||
| * Develop frontend: `cd CourseReview/frontend` and treat it like a normal git repo. | ||
|
|
||
| - Clone the frontend repo as a seperate repo from `CourseReview`(backend): |
There was a problem hiding this comment.
This line has two issues: 1) "seperate" should be spelled "separate", and 2) missing space before the opening parenthesis - should be "from CourseReview (backend):"
| - Clone the frontend repo as a seperate repo from `CourseReview`(backend): | |
| - Clone the frontend repo as a separate repo from `CourseReview` (backend): |
No description provided.