Skip to content

Commit 9a1660d

Browse files
committed
Update URLs and improve writing in some places
1 parent 9cfdda9 commit 9a1660d

16 files changed

Lines changed: 94 additions & 114 deletions

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
1-
# documentation
2-
Documentation website for the FuckingNode CLI tool.
1+
# FuckingNode documentation
2+
3+
Live at [this URL](https://fuckingnode.github.io/). Documentation website for the FuckingNode CLI tool. Also includes installer scripts.

docs/about/branding.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,13 @@ Just in case you wanted to write an article or make a video about us (thank you!
66

77
## The logo
88

9-
You can use our logo just as you'd use any app's logo in a post, video, or any kind of visual content that requires it. With proper attribution, of course. A PNG is available from our main repository.
10-
11-
Please don't alter it however. Only valid change is making it full black (`#000`) instead of full white (`#FFF`) for usage over light backgrounds.
9+
You can use our logo just as you'd use any app's logo in a post, video, or any kind of visual content that requires it (with proper attribution, of course). Black and white PNGs are available from this website's repository.
1210

1311
## The name
1412

15-
Ideally, capitalize it as FuckingNode. The asterisk (F*ckingNode) is optional. If used, censor the U and not any other letter (<s>F\*ckingNode</s>).
13+
Ideally, capitalize it as FuckingNode. The asterisk (F*ckingNode) is optional. If used, censor the U and not any other letter (avoid things like <s>F\*\*kingNode</s>).
1614

17-
There isn't any preference towards font families to be used. We recommend a `monospace` font.
15+
There isn't a real preference towards font families to be used. We recommend a `monospace` font.
1816

1917
### Can acronyms or abbreviations be used?
2018

@@ -24,9 +22,9 @@ There isn't any preference towards font families to be used. We recommend a `mon
2422

2523
**Keep the logo white or black.** If you _really_ want to color it, go for either light green (like this documentation site's accent color), or orange. `#FCA737` (our classic orange) or `#65BA4F` (lightened NodeJS' logo green) could do.
2624

27-
## Something needless to say
25+
## Needless to say
2826

29-
Our logo, name, and branding are _ours_. They're made with love and effort and they may not be used anywhere without either crediting us or having our explicit consent. Copyright actions might be taken if we see them necessary; we hope you'll be able to abide by such a simple rule.
27+
Our logo, name, and branding are _ours_. They're made with love and effort and they may not be used anywhere without either crediting us or having our explicit consent. Copyright actions may be taken if we see them necessary; so we hope you'll be able to abide by such a simple rule.
3028

3129
---
3230

docs/about/roadmap.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -68,15 +68,13 @@ We'll expand (and rarely, but not impossibly, shrink) this roadmap as we make pr
6868

6969
### Version 3.3
7070

71-
- [ ] Stabilize `audit` feature and support it everywhere NodeJS.
72-
- [ ] Stabilize it
73-
- [ ] Fix known issues (see TODO.md at the repository).
74-
- [ ] Expand vector string lists.
75-
- [x] Support it
76-
- [x] pnpm
77-
- [x] yarn
78-
- [ ] Extend the FuckingNode Interop Layer
79-
- [ ] Auditer (this is a bit special, you'll see what we mean soon).
71+
- [ ] Rewrite `audit` feature.
72+
- [ ] Stabilize it
73+
- [ ] Fix known issues (see TODO.md at the repository).
74+
- [ ] Expand vector string lists & question list.
75+
- [x] Support it everywhere NodeJS
76+
- [x] pnpm
77+
- [x] yarn
8078

8179
---
8280

docs/about/social.md

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,38 @@
1+
<!-- markdownlint-disable md033 md030 -->
12
# Follow us
23

3-
- [Discord server](https://discord.gg/AA2jYAFNmq) - Our community server is probably the most important part of the community. Sneak peeks, feature suggestions, and important announcements live here.
4-
- [Bluesky](https://bsky.app/profile/fknode.bsky.social) - Twitter, but better because these guys kept their "bird" (well it's a butterfly but you get my point).
5-
- [Twitter](https://x.com/FuckingNode) - Users who refer to this platform as "X" instead of "Twitter" will be prohibited from using FuckingNode.
6-
- [YouTube](https://youtube.com/watch?v=_lppvGYUXNk) - This one isn't really _our own_, as this is my (the creator's) personal channel and has unrelated stuff. Still, major release trailers will live here so it's worth noting.
4+
<div class="grid cards" markdown>
5+
6+
- :fontawesome-brands-discord:{ .lg .middle } __[Discord server](https://discord.gg/AA2jYAFNmq)__
7+
8+
---
9+
10+
Our community server is probably the most important part of the community. Sneak peeks, feature suggestions, and important announcements live here.
11+
12+
[:octicons-arrow-right-24: Join us](https://discord.gg/AA2jYAFNmq)
13+
14+
- :fontawesome-brands-bluesky:{ .lg .middle } __[Bluesky](https://bsky.app/profile/fknode.bsky.social)__
15+
16+
---
17+
18+
Basically Twitter but better because these guys kept their bird (I mean it's a butterfly not a bird but you get my point).
19+
20+
[:octicons-arrow-right-24: Follow us](https://bsky.app/profile/fknode.bsky.social)
21+
22+
- :fontawesome-brands-twitter:{ .lg .middle } __[Twitter](https://x.com/FuckingNode)__
23+
24+
---
25+
26+
Users who refer to this platform as "X" instead of "Twitter" will be prohibited from using FuckingNode.
27+
28+
[:octicons-arrow-right-24: Follow us](https://x.com/FuckingNode)
29+
30+
- :fontawesome-brands-youtube:{ .lg .middle } __[YouTube](https://youtube.com/watch?v=_lppvGYUXNk)__
31+
32+
---
33+
34+
This isn't really _our own YouTube_, it's the creator's personal channel and has unrelated stuff. Still, major release trailers will be here (and a trailer for V3 is work in progress).
35+
36+
[:octicons-arrow-right-24: Watch us](https://youtube.com/watch?v=_lppvGYUXNk)
37+
38+
</div>

docs/about/why.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,6 @@ FuckingNode is a thing because it fixes all of the issues mentioned above.
6565

6666
---
6767

68-
That is why FuckingNode is a thing; because it's a single tool to fix everything. And if there's something we didn't fix yet, just [join our Discord server](https://discord.gg/AA2jYAFNmq), mention us on [Twitter](https://x.com/FuckingNode) or [Bluesky](https://bsky.app/FuckingNode), or [raise an issue on GitHub](https://github.com/ZakaHaceCosas/FuckingNode/issues) telling us what else you'd like to see within our tooling, and we'll add it (if possible).
68+
That is why FuckingNode is a thing; because it's a single tool to fix everything. And if there's something we didn't fix yet, just [join our Discord server](https://discord.gg/AA2jYAFNmq), mention us on [Twitter](https://x.com/FuckingNode) or [Bluesky](https://bsky.app/profile/fknode.bsky.social), or [raise an issue on GitHub](https://github.com/FuckingNode/FuckingNode/issues) telling us what else you'd like to see within our tooling, and we'll add it (if possible).
6969

7070
*[CWD]: Current Working Directory

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,23 +37,23 @@
3737

3838
Never again make a commit without running your test-suite test.
3939

40-
[:octicons-arrow-right-24: Safe commits](https://zakahacecosas.github.io/FuckingNode/manual/commit/)
40+
[:octicons-arrow-right-24: Safe commits](./manual/commit.md)
4141

4242
- :fontawesome-solid-skull:{ .lg .middle } **Be prepared for anything**
4343

4444
---
4545

4646
With the world’s only chad-enough JavaScript CLI to auto-deprecate projects at will.
4747

48-
[:octicons-arrow-right-24: Automated deprecations](https://zakahacecosas.github.io/FuckingNode/manual/surrender/)
48+
[:octicons-arrow-right-24: Automated deprecations](./manual/surrender.md)
4949

5050
- :material-arm-flex:{ .lg .middle } **Flex about it**
5151

5252
---
5353

5454
Your friends waste lots of their time manually maintaining never-releasing JS projects. Show 'em the F\*ckingNode way.
5555

56-
[:octicons-arrow-right-24: Download now](https://github.com/ZakaHaceCosas/FuckingNode/releases/latest)
56+
[:octicons-arrow-right-24: Download now](https://github.com/FuckingNode/FuckingNode/releases/latest)
5757

5858
</div>
5959

docs/learn/audit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ $$
8585
There is a `--strict` flag that can be passed to the audit command that adds an additional **risk bump**, based on the severity of the most-severe identified vulnerability, as follows:
8686

8787
$$
88-
Strict R.B. = \frac{R.F. + (R.B. \times 100)}{2}
88+
Strict R.F. = \frac{R.F. + (R.B. \times 100)}{2}
8989
$$
9090

9191
RB values are as follows:

docs/learn/cross-runtime-support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Reasons for not supporting a feature are the following.
2323

2424
## Partial Deno, Bun, Cargo & Go support for cleanup
2525

26-
In both runtimes, the kind of cleanup commands we'd use (`prune`, `dedupe`...) aren't available.
26+
In both runtimes, the kind of cleanup commands we'd use (`prune`, `dedupe`...) aren't available, so the _cleanup itself_ isn't available. `clean` will still work with them, as lintage, prettification, or updates may work. Run `fuckingnode compat cleaner`.
2727

2828
## No Deno support for hard cleanup
2929

docs/learn/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Learn: How does F*ckingNode work from the inside?
22

3-
For wannabe contributors or people curious / bored enough, all pages in here explain in detail how does each feature work from an insider perspective.
3+
For wannabe contributors or curious / bored enough people, pages in here explain in detail how do our most important features work from an insider perspective.
44

55
Only features worth including are mentioned - not because other features are worthless, but because some of them simply don't need a page.
66

77
> `fuckingnode setup` for example is simple enough to be understood; a list of templates, you give it a name, and if a template with that name exists, it creates a file and writes the template to it (or overwrites an existing one, deep-merging if possible).
8-
> It's simplicity saves us a few pages up.
8+
>
9+
> Its simplicity removes the need to make a "learning page", saving a few pages up.
910
1011
## Table of Contents
1112

1213
- [Clean](clean.md)
13-
- [Kickstart](kickstart.md)
1414
- [(Experimental) Audit](audit.md)

docs/learn/kickstart.md

Lines changed: 0 additions & 52 deletions
This file was deleted.

0 commit comments

Comments
 (0)