Skip to content

Commit 3be0a0d

Browse files
make communit-at presentable
1 parent 65a2b72 commit 3be0a0d

File tree

18 files changed

+252
-35
lines changed

18 files changed

+252
-35
lines changed

astro.config.mjs

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
import { defineConfig } from "astro/config";
33
import starlight from "@astrojs/starlight";
44
import starlightSidebarTopics from "starlight-sidebar-topics";
5+
import starlightLinksValidator from "starlight-links-validator";
56

67
// https://astro.build/config
78
export default defineConfig({
@@ -24,7 +25,7 @@ export default defineConfig({
2425
link: "/sociocracy",
2526
items: [
2627
{
27-
label: "Example Guide",
28+
label: "About Sociocracy",
2829
autogenerate: { directory: "sociocracy" },
2930
},
3031
],
@@ -43,11 +44,15 @@ export default defineConfig({
4344
{
4445
label: "FujoCoded Resources",
4546
icon: "seti:db",
46-
link: "/fujowebdev",
47+
link: "/fujowebdev/style-guide",
4748
items: [
4849
{
49-
label: "Writing for FujoGuide",
50-
autogenerate: { directory: "fujowebdev" },
50+
label: "FujoGuide Style Guide",
51+
autogenerate: { directory: "fujowebdev/style-guide" },
52+
},
53+
{
54+
label: "Extra Bits",
55+
autogenerate: { directory: "fujowebdev/extras" },
5156
},
5257
{
5358
label: "GitHub Resources",
@@ -56,6 +61,7 @@ export default defineConfig({
5661
],
5762
},
5863
]),
64+
starlightLinksValidator(),
5965
],
6066
}),
6167
],

package-lock.json

Lines changed: 128 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
"@astrojs/starlight": "^0.36.1",
1414
"astro": "^5.14.5",
1515
"sharp": "^0.32.5",
16+
"starlight-links-validator": "^0.19.2",
1617
"starlight-sidebar-topics": "^0.6.2"
1718
},
1819
"repository": {

src/assets/bobawip-color.png

248 KB
Loading

src/assets/community-at-hero.png

1.6 MB
Loading

src/assets/community-at-hero.webp

-377 KB
Binary file not shown.

src/content/docs/fujowebdev/learn-along-notes.md renamed to src/content/docs/fujowebdev/extras/learn-along-notes.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,25 @@
11
---
2-
title: Notes from Writing the Learn-Along
2+
title: Ms Boba's Extra Notes from Writing the Learn-Along
33
sidebar:
44
order: 6
55
---
66

7-
Notes from my review of our learn-along, that show changes I made and how I
7+
Notes from my [Ms Boba's] review of our learn-along, that show changes I made and how I
88
came to them. I had to formulate principles post-facto, as I never really
99
spelled them out before.
1010

1111
I had already seen (and written part of) the writing beforehand. Hopefully
1212
this will help me get it right quicker myself next time—I keep forgetting
1313
this is how we write.
1414

15+
:::caution[Classic Ms Boba]
16+
17+
I changed a lot of this again before shipping the learn along, so some of this may be
18+
inaccurate/different in the final version. I think the general principles hold, but
19+
take all this with a big asterisk.
20+
21+
:::
22+
1523
## Fortune Generator — Before You Start
1624

1725
I'll go through each change by bit, but if you want to read the before/after in full,
@@ -177,7 +185,7 @@ you can find it here.
177185

178186
### The Preamble
179187

180-
Principles extracted:
188+
Principles I extracted:
181189

182190
- **Active, narrative voice:** Don't describe what the code is, actively (and
183191
cheerfully) explain what it does.
@@ -224,13 +232,15 @@ Extra things I considered changing:
224232
225233
### Prerequisites #1
226234
227-
Principles extracted:
235+
Principles I extracted:
228236
229237
- **Write _to_ the audience:** Address the reader directly, set clear
230238
expectations, and anticipate questions they may have. Talk about different
231239
ways they might approach the material.
232240
- **Call to adventure:** You're telling the tale of a valiant hero that is about
233-
to go fight a trecherous enemy (JavaScript). Your language should reflect that.
241+
to go embark on a trecherous journey, and your language should reflect that.
242+
Note that this doesn't mean that itself JavaScript is treacherous: it's just what
243+
Boba-tan tells herself to psych herself up.
234244
- **Group related content, don't change "subject":** Paragraphs and sections
235245
often serve specific purposes. Don't let unrelated notes slip in: move them
236246
around, or reframe them so they match their surroundings.
@@ -347,7 +357,7 @@ What I notice:
347357
348358
- **Frame challenges as fun, approachable, and within the person's reach:** When
349359
a task feels overwhelming, try thinking about what could make it easier for
350-
them and where they're likely to get stuck. Try getting them "out of their
360+
them and where they're likely to get stuck. Try getting them "out of their own
351361
heads".
352362
- **Normalize struggling with code, and encourage a growth mindset:** Where you can,
353363
offer suggestions on how to tackle a task, and remind people it's ok to struggle
File renamed without changes.

src/content/docs/fujowebdev/index.md renamed to src/content/docs/fujowebdev/style-guide/index.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@ sidebar:
44
order: 1
55
---
66

7+
:::caution
8+
9+
This style guide is an older version we've been reworking. New one will be
10+
published soon.
11+
12+
:::
13+
714
Clear and approachable learning content for beginner-to-intermediate hobbyist
815
web developers that is:
916

@@ -43,7 +50,7 @@ We assume they:
4350
As we write, we primarily imagine an audience that is:
4451

4552
- **Very online**, aware of online memes and parlance
46-
- **Millennial**, coming online around the 00s-10s period (or wishing they had)
53+
- **Wistfully Millennial**, coming online around the 00s-10s period (or wishing they had)
4754
- **Nostalgic**, of a time when the internet didn’t take itself so seriously and
4855
possibilities felt endless
4956
- **Unapologetically passionate**, not afraid of being seen as “cringe” as they

src/content/docs/fujowebdev/role-and-material.md renamed to src/content/docs/fujowebdev/style-guide/role-and-material.md

File renamed without changes.

0 commit comments

Comments
 (0)