-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Update: (root) README #2010
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update: (root) README #2010
Changes from 1 commit
616fe00
61b0883
6fad6bf
000aad3
b167db0
0c06fa8
5481388
289edb6
3461aa1
283537a
3f0cb77
d9c5731
aaf72d5
3adf702
bf34f05
b33b0f8
ef25c49
b5f4412
aee7190
1311004
863f29f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -56,19 +56,15 @@ git reset --hard | |
| > **Note:** | ||
| > If you already have a full clone and wish to focus on a subset of the repository, you may use the `git sparse-checkout set [...]` command as shown above. | ||
|
|
||
| Here is a detailed list of the relevant directories: | ||
| ### Directory Structure | ||
|
|
||
| - If you want to test any page rendering using Hugo: | ||
| - layouts/ | ||
| - content/ | ||
| - static/ | ||
| - assets/ | ||
| - **layouts/**, **content/**, **static/**, **assets/**: For testing page rendering with Hugo. | ||
| - **data/**: For adding new GUI client data. | ||
| - **script/**: For pre-rendering pages sourced from other repositories (e.g., ProGit book). | ||
| - **.github/**: Contains GitHub workflow configurations. | ||
| - **external/book/**, **external/docs/**: Pre-rendered pages (do not edit directly). | ||
|
|
||
| - To add new GUIs: | ||
| - data/ | ||
|
Comment on lines
-40
to
-41
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. While you may find it clearer, the original intention of this section was to answer the question "Which directories do I need in my sparse checkout?". That's kind of gone, the reader now has to cobble together what they need from that admittedly neat-looking (but less helpful) bullet list. |
||
|
|
||
| - To work on pre-rendering pages that originate from other repositories (such as the ProGit book): | ||
| - script/ | ||
| --- | ||
|
|
||
| - To work on the GitHub workflows that perform the automated, scheduled pre-rendering: | ||
| - .github/ | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please compare the visual of
> [!NOTE]vs**Note:**. I find the former vastly better and would highly recommend to keep it.