improve docs #553
Merged
improve docs #553
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This pull request improves the clarity and consistency of the documentation for the DB course lab by revising the formatting and numbering of various instructional sections across multiple lab files.
- Updated section headings to include numeric indicators for better ordering (e.g., “2. 准备自己的开发环境” and “3. …”).
- Standardized the bullet list style for instructions and command examples in lab1, lab2, lab3, and lab4.
- Minor formatting tweaks ensure that each lab document provides clear, self-contained steps for code setup and testing.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/docs/db_course_lab/overview.md | Updated heading numbering and bullet list formatting |
| docs/docs/db_course_lab/lab4.md | Converted numbered steps to bullet lists for command instructions |
| docs/docs/db_course_lab/lab3.md | Added a Git workflow block; ensured clarity in instructions |
| docs/docs/db_course_lab/lab2.md | Introduced a self-contained Git workflow guide |
| docs/docs/db_course_lab/lab1.md | Minor formatting adjustments in the notes for clarity |
Comments suppressed due to low confidence (2)
docs/docs/db_course_lab/overview.md:48
- [nitpick] The renumbered section header improves clarity; please ensure that all documentation files consistently adopt this numbering style throughout.
#### 2. 准备自己的开发环境
docs/docs/db_course_lab/lab3.md:9
- [nitpick] Verify that any outdated or redundant instruction markers (e.g., the previous arrow-style instructions) have been cleaned up to avoid confusing readers with multiple sets of instructions.
每次实验代码更新，需要将代码从远端仓库拉取下来，大家需要从 miniob 的 github 仓库上把代码拉取到本地。
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.
What problem were solved in this pull request?
Issue Number: close #xxx
Problem:
What is changed and how it works?
Other information