Compare commits

..

3 Commits

Author SHA1 Message Date
5c8c6e8760
docs: remove unicode chars 2024-05-11 21:54:55 +02:00
85ac8080f4
chore(doc): run and modify formatting rules 2024-05-11 21:48:06 +02:00
0751699bc8
docs: more docs guidelines 2024-05-11 21:22:25 +02:00
8 changed files with 69 additions and 23 deletions

View File

@ -1,2 +1,5 @@
default: true
MD010: false # Ignore tabs in code blocks
MD013: false # Don't wrap lines by default
MD046:
style: "fenced" # Force fenced code blocks

View File

@ -135,16 +135,18 @@ Sets the browser window/tab title.
Reconfigures the terminal layout, potentially into multiple split panes.
terminal.split([
{
```javascript
terminal.split(
[{
type: "horizontal",
children: [
{name: "left", basis: "2in", grow: 0, shrink: 0},
{name: "middle", grow: 1},
{name: "right", basis: "2in", grow: 0, shrink: 0},
],
},
]);
}]
);
```
#### terminal.select(name)

View File

@ -28,7 +28,7 @@ Dependencies for Windows:
2. Run `make -j $(nproc) debug` or `make -j $(nproc) release`
> If you're unsure whether you should choose `debug` or `release`, stick to `release`.
If you're unsure whether you should choose `debug` or `release`, stick to `release`.
> `-j $(nproc)` will start a compiler for every CPU thread, which will dramatically reduce the time needed to compile Tilde Friends.
@ -44,15 +44,15 @@ Now that you have a binary, head over to <running.md>.
## Troubleshooting
### The compiler throws an error and I can't build the binary.
### The compiler throws an error and I can't build the binary
Open `GNUMakefile` and edit the CFLAGS environment variable around line 50.
For example given this error:
```
src/http.c: In function tf_http_get_cookie:
src/http.c:1089:128: error: check of name for NULL after already dereferencing it [-Werror=analyzer-deref-before-check]
```text
src/http.c: In function 'tf_http_get_cookie':
src/http.c:1089:128: error: check of 'name' for NULL after already dereferencing it [-Werror=analyzer-deref-before-check]
```
Add:

View File

@ -12,12 +12,21 @@ Alternatively, you can change the `origin` remote on your existing clone:
- I want to edit C code !
TODO
- I want to edit JavaScript code !
TODO
- I want to write documentation !
Great! Before you do, have a look at the [documentation guidelines](guidelines/documentation-guidelines.md) to learn how to write consistent documentation.
In all cases:
- Make sure that your commit messages are descriptive.
<!-- - hi -->
- Format your changes:
If you've edited C code: run `make format`

View File

@ -14,4 +14,6 @@ See <faq.md>.
## Guide
See <guide.md>.
This document will be phased out and integrated into the new documentation.
See <.guide.md>.

View File

@ -4,6 +4,6 @@
See <running.md>.
### The compiler throws an error and I can't build the binary.
### The compiler throws an error and I can't build the binary
See <building.md>.

View File

@ -26,7 +26,37 @@ When writing documentation, the author should have in mind it's target audience:
### Style guide
TODO
1. Lines SHOULD NOT be wrapped, to allow clients to dynamically wrap them however they want:
```text
This is not very pleasant to read because
the text
is manually wrapped, but the size of the
screen is
smaller than the size the text is wrapped
at. I
need to write even more useless text here
so I get
my point across. Also hi! If you're here
that
means you're either going to contribute to
Tilde
Friends, or that you're reviewing my
stupid
changes. Either way, you're awesome!
```
You MAY use one line per sentence.
2. Lines ending with an `inline code block` SHOULD NOT end with a period.
> Example: To build in docker, `docker build .`
NB: this does not apply to file names or other text that are not meant to be copy-pasted.
> Example: this document is named `docs/guidelines/documentation-guidelines.md` instead of `docs/guidelines/documentation.md` because it could cause confusion with `docs/documentation.md`.
More TODO
## License

View File

@ -3,7 +3,7 @@
"scripts": {
"format": "npm run prettier && npm run markdown",
"prettier": "npx prettier --cache --write --check .",
"markdown": "npx markdownlint-cli 'docs/**/*.md' -f"
"markdown": "npx markdownlint-cli --fix 'docs/**/*.md'"
},
"author": "Cory McWilliams",
"license": "MIT",