From e1fdb37ef4a082fedbf3b6e842bd0b091f0452bb Mon Sep 17 00:00:00 2001 From: Sidney Date: Sat, 4 Jan 2025 16:08:40 +0100 Subject: [PATCH] Made changes to contributing file with new src folder in mind --- CONTRIBUTING.md | 42 ++++++++++++++++++++---------------------- 1 file changed, 20 insertions(+), 22 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ae3216d9..87658f42 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -40,9 +40,7 @@ This project and everyone participating in it is governed by the 3. Then, inside a version control software like GitHub Desktop, add the repository you just forked via the clone function (_File > Clone repository_. The HTTPS link can be copied from the main repository page with the _<> Code_ button). -4. Inside the version control software, switch the branch to the one containing the development content (v4). - -5. Inside the repository folder, using any terminal, execute the following commands: +4. Inside the repository folder, navigate into the "_src_" folder and inside it, using any terminal, execute the following commands: ```shell npm i @@ -73,7 +71,7 @@ The owner of this repo, Sidney, can also be contacted on Discord with the userna ### Work in Progress Sections -Work in progress pages are in the `/content/work_in_progress` folder and are hidden from the website, meaning they can +Work in progress pages are in the `src/content/work_in_progress` folder and are hidden from the website, meaning they can contain rough drafts. Inside this folder, you can create your own folder, like `YourName-wip`. You can, of course, also keep your work in progress local or in your fork, but some like to share their work in progress pages with others so that others might take over and continue fine-tuning them. @@ -98,24 +96,24 @@ page search. ### General -| | Description | Examples | -| :----------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :--------------------------------------: | -| **Language** | Use American English and not British English. | color, not colour | -| **How to Address the Readers** | It has not been decided yet if the reader is to be addressed with "you" or if one rather uses "one". Currently, most of the handbook uses "one". (Trying not to address the reader as much as possible is also an option.) | You or One | -| **Writing Style** | Be concise and informative with what you write, trying to keep sentences only as long as they have to bey to convey the point that is being made. Treat the writing style more like a scientific research paper and less like some article.

Your north star should be to not unnecessarily waste the reader's time while at the same time not skimping out on detailed information.

There are many ways of doing this, and often restructuring a sentence can make it a lot shorter while still keeping the important information. It can also be a good idea to try to get to the point relatively quickly and to go into more detail in subsections like admonition blocks.

3D is quite a complex subject, and the oversight can often be lost, so keeping things intuitively structured is also important. | | -| **Showing Menu Paths** | Use the greater-than angle brackets `>` to show the flow of navigation through menus. Make sure to keep a space between the arrows and words. Lastly´, make the entire path Italic (Italics are done with `_`). | _Settings > Path_ | -| **Showing Hotkeys** | Use [inline code](https://help.obsidian.md/Editing+and+formatting/Basic+formatting+syntax#Inline+code) _(or inline literals)_, separated with a `+`, to format each keystroke in a certain shortcut _(hotkey)_. (Inline code: `) | `Ctrl` + `F` | -| **Units Denoter** | The unit value and the denoter should be together without a spacing. In addition, the denoter should be lowercase. | 16px, 16bit, 16cm, 16m, 16km, 16kg | -| **Unit System** | Use the metric system (no inches or feet, for example). | | -| **Headings** | The biggest heading a page should have is H2. | ## Heading | -| **Capitalization** | Besides using basic English grammar for capitalization, there are some other things worth mentioning. Headers in pages should follow the [Chicago capitalization](https://en.wikipedia.org/wiki/Title_case) guideline. (If unsure, this [Capitalize My Title](https://capitalizemytitle.com/style/Chicago/) website can help format headers. Always capitalize software and tool names.) Lastly, for the headers of admonitions / callout blocks, use normal sentence capitalization. | | -| **Links** | Links to articles or YouTube videos should, if possible, include the name or some information, so that if the link is broken because the website or video is taken down, the reader can maybe still find it through some searching. | [Descriptive Link Name]() | -| **Images** | Never ever add images via links. Always download the image and add it to the "_.../content/images_" folder. This is because it's quite likely that in a couple of years that image will not exist anymore at its source (e.g., the recent Imgur collapse).

Also, try keeping the image at reasonable file sizes (like under 500kb) and, if possible, in the JPG image format, to not affect page load times. | | -| **File Extensions** | When writing out a file name that includes a file extension, write the extension in lowercase. However, when talking about a file extension in a general sense, remove the dot and capitalize all letters. | .png, .blend, .zpr / PNG, BLEND, ZPR | -| **Abbreviations & Acronyms** | Try not to use abbreviations, except if they are very commonly used. Like the term UDIM which stands for U DIMension but is only ever used in its abbreviated form.

Using common abbreviations like: etc. (Et Cetera), i.e. (in other words), e.g. (for example), c.a. (circa / about) is ok, but writing it out is just as valid. | UDIM, etc., i.e., e.g., c.a. | -| **Contraction** | Use contractions whenever possible, as they will mostly make sentences sound more fluent and pretty (e.g. "has not" becomes "hasn't"). | doesn't, don't, hasn't, he'll, it's, ... | -| **Slashes** | When using slashes, always leave a space before and after the slash. | 1 / 2, Blender / Maya | -| **Bold** | No standards yet. May be good for highlighting key terms, but try to use it sparingly. | | +| | Description | Examples | +| :----------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------: | +| **Language** | Use American English and not British English. | color, not colour | +| **How to Address the Readers** | It has not been decided yet if the reader is to be addressed with "you" or if one rather uses "one". Currently, most of the handbook uses "one". (Trying not to address the reader as much as possible is also an option.) | You or One | +| **Writing Style** | Be concise and informative with what you write, trying to keep sentences only as long as they have to bey to convey the point that is being made. Treat the writing style more like a scientific research paper and less like some article.

Your north star should be to not unnecessarily waste the reader's time while at the same time not skimping out on detailed information.

There are many ways of doing this, and often restructuring a sentence can make it a lot shorter while still keeping the important information. It can also be a good idea to try to get to the point relatively quickly and to go into more detail in subsections like admonition blocks.

3D is quite a complex subject, and the oversight can often be lost, so keeping things intuitively structured is also important. | | +| **Showing Menu Paths** | Use the greater-than angle brackets `>` to show the flow of navigation through menus. Make sure to keep a space between the arrows and words. Lastly´, make the entire path Italic (Italics are done with `_`). | _Settings > Path_ | +| **Showing Hotkeys** | Use [inline code](https://help.obsidian.md/Editing+and+formatting/Basic+formatting+syntax#Inline+code) _(or inline literals)_, separated with a `+`, to format each keystroke in a certain shortcut _(hotkey)_. (Inline code: `) | `Ctrl` + `F` | +| **Units Denoter** | The unit value and the denoter should be together without a spacing. In addition, the denoter should be lowercase. | 16px, 16bit, 16cm, 16m, 16km, 16kg | +| **Unit System** | Use the metric system (no inches or feet, for example). | | +| **Headings** | The biggest heading a page should have is H2. Furthermore, don't add hashtags `#` behind headers. | ## Heading | +| **Capitalization** | Besides using basic English grammar for capitalization, there are some other things worth mentioning. Headers in pages should follow the [Chicago capitalization](https://en.wikipedia.org/wiki/Title_case) guideline. (If unsure, this [Capitalize My Title](https://capitalizemytitle.com/style/Chicago/) website can help format headers. Always capitalize software and tool names.) Lastly, for the headers of admonitions / callout blocks, use normal sentence capitalization. | | +| **Links** | Links to articles or YouTube videos should, if possible, include the name or some information, so that if the link is broken because the website or video is taken down, the reader can maybe still find it through some searching. | [Descriptive Link Name]() | +| **Images** | Never ever add images via links. Always download the image and add it to the "_.../content/images_" folder. This is because it's quite likely that in a couple of years that image will not exist anymore at its source (e.g., the recent Imgur collapse).

Also, try keeping the image at reasonable file sizes (like under 500kb) and, if possible, in the JPG image format, to not affect page load times. | | +| **File Extensions** | When writing out a file name that includes a file extension, write the extension in lowercase. However, when talking about a file extension in a general sense, remove the dot and capitalize all letters. | .png, .blend, .zpr / PNG, BLEND, ZPR | +| **Abbreviations & Acronyms** | Try not to use abbreviations, except if they are very commonly used. Like the term UDIM which stands for U DIMension but is only ever used in its abbreviated form.

Using common abbreviations like: etc. (Et Cetera), i.e. (in other words), e.g. (for example), c.a. (circa / about) is ok, but writing it out is just as valid. | UDIM, etc., i.e., e.g., c.a. | +| **Contraction** | Use contractions whenever possible, as they will mostly make sentences sound more fluent and pretty (e.g. "has not" becomes "hasn't"). | doesn't, don't, hasn't, he'll, it's, ... | +| **Slashes** | When using slashes, always leave a space before and after the slash. | 1 / 2, Blender / Maya | +| **Bold** | No standards yet. May be good for highlighting key terms, but try to use it sparingly. | | ### Specific