Skip to content

Commit 7a9fbf7

Browse files
authored
Update docs (#44)
* update docs * add typescript reference * clean up & format * add period at end of sentence
1 parent b806d75 commit 7a9fbf7

File tree

2 files changed

+24
-62
lines changed

2 files changed

+24
-62
lines changed

content/guidelines.md

Lines changed: 22 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,11 @@ recent years:
4242

4343
Like dependencies, we try to reduce the amount of general-purpose programming
4444
languages we use for [PeopleForBikes] projects, therefore we decided to only
45-
adopt Javascript, [Rust] and [Python].
45+
adopt [TypeScript], [Rust] and [Python].
4646

4747
They are respectively used for the following use cases:
4848

49-
- Web projects must be written in Javascript
49+
- Web projects must be written in [TypeScript].
5050
- Projects dealing with data science or GIS must be written in [Python].
5151
- All other projects must be written in [Rust].
5252

@@ -229,42 +229,9 @@ poetry add -G dev \
229229

230230
## Web
231231

232-
Web project must be built with [React], [Next.js] and [Tailwind CSS].
233-
234-
### Tailwind CSS
235-
236-
#### tailwind.config.js
237-
238-
We extend the existing [Tailwind CSS] theme with the PFB fonts and colors:
239-
240-
```js
241-
// tailwind.config.js
242-
243-
module.exports = {
244-
content: [
245-
"./pages/**/*.{js,ts,jsx,tsx}",
246-
"./components/**/*.{js,ts,jsx,tsx}",
247-
],
248-
theme: {
249-
fontFamily: {
250-
sans: ["Montserrat", "sans-serif"],
251-
dharma": ["Dharma Gothic E"],
252-
},
253-
extend: {
254-
colors: {
255-
"pfb-deep-navy": "#00263E",
256-
"pfb-bright-cyan": "#009EDB",
257-
"pfb-bright-red": "#D71920",
258-
"pfb-coal": "#4D4D4F",
259-
"pfb-gray": "#8B8A8D",
260-
},
261-
},
262-
},
263-
plugins: [],
264-
};
265-
```
232+
Web projects will be built with [Next.js] using [TypeScript]
266233

267-
#### Custom fonts
234+
### Custom fonts
268235

269236
PFB uses some custom private fonts that require some setup in order to be used.
270237

@@ -297,9 +264,6 @@ Add the new `font-faces` to `styles/globals.css`:
297264
}
298265
```
299266

300-
A new custom font family is now available using the [Tailwind CSS] class
301-
`font-dharma`.
302-
303267
#### Component Collections
304268

305269
Here are the components collection that have been selected by the team:
@@ -332,39 +296,38 @@ Here are the components collection that have been selected by the team:
332296
[aiohttp]: https://docs.aiohttp.org/en/stable/
333297
[clap]: https://clap.rs/
334298
[color-eyre]: https://github.com/yaahc/color-eyre
335-
[furo]: https://pradyunsg.me/furo/
299+
[furo]: https://pradyunsg.me/furo
336300
[indicatif]: https://github.com/mitsuhiko/indicatif
337-
[invoke]: https://www.pyinvoke.org/
338-
[isort]: https://pycqa.github.io/isort/
301+
[invoke]: https://www.pyinvoke.org
302+
[isort]: https://pycqa.github.io/isort
339303
[loguru]: https://github.com/Delgan/loguru
340304
[markdownlint]: https://github.com/DavidAnson/markdownlint
341-
[myst-parser]: https://myst-parser.readthedocs.io/en/latest/
342-
[next.js]: https://nextjs.org
343-
[poetry]: https://python-poetry.org/
344-
[pydantic]: https://pydantic-docs.helpmanual.io/
305+
[myst-parser]: https://myst-parser.readthedocs.io/en/latest
306+
[next.js]: https://nextjs.org/docs
307+
[poetry]: https://python-poetry.org
308+
[pydantic]: https://pydantic-docs.helpmanual.io
345309
[pytest-cov]: https://github.com/pytest-dev/pytest-cov
346-
[pytest-mock]: https://github.com/pytest-dev/pytest-mock/
310+
[pytest-mock]: https://github.com/pytest-dev/pytest-mock
347311
[pytest-rerunfailures]: https://github.com/pytest-dev/pytest-rerunfailures
348312
[pytest-socket]: https://github.com/miketheman/pytest-socket
349313
[pytest-xdist]: https://github.com/pytest-dev/pytest-xdist
350314
[pytest]: https://docs.pytest.org/en/latest
351-
[react]: https://reactjs.org/
352315
[reqwest]: https://github.com/seanmonstar/reqwest
353316
[rich]: https://github.com/Textualize/rich
354317
[ruff]: https://github.com/charliermarsh/ruff
355-
[seaorm]: https://www.sea-ql.org/SeaORM/
356-
[serde]: https://serde.rs/
318+
[seaorm]: https://www.sea-ql.org/SeaORM
319+
[serde]: https://serde.rs
357320
[shellcheck]: https://github.com/koalaman/shellcheck
358321
[shfmt]: https://github.com/mvdan/sh
359322
[sphinx-autobuild]: https://github.com/executablebooks/sphinx-autobuild
360323
[sphinx-copybutton]: https://github.com/executablebooks/sphinx-copybutton
361-
[sphinx]: https://www.sphinx-doc.org/en/master/
324+
[sphinx]: https://www.sphinx-doc.org/en/master
362325
[sqlfluff]: https://docs.sqlfluff.com/en/stable/index.html
363-
[tailwind css]: https://tailwindcss.com/
364-
[tenacity]: https://tenacity.readthedocs.io/en/latest/
365-
[tracing.rs]: https://tracing.rs/tracing/
366-
[tokio]: https://tokio.rs/
367-
[typer]: https://typer.tiangolo.com/
326+
[tenacity]: https://tenacity.readthedocs.io/en/latest
327+
[tracing.rs]: https://tracing.rs/tracing
328+
[tokio]: https://tokio.rs
329+
[typer]: https://typer.tiangolo.com
330+
[typescript]: https://www.typescriptlang.org
368331
[xdoctest]: https://github.com/Erotemic/xdoctest
369332

370333
<!-- Tooling -->
@@ -374,5 +337,5 @@ Here are the components collection that have been selected by the team:
374337
<!-- General links -->
375338

376339
[peopleforbikes]: https://github.com/PeopleForBikes
377-
[python]: https://www.python.org/
378-
[rust]: https://www.rust-lang.org/
340+
[python]: https://www.python.org
341+
[rust]: https://www.rust-lang.org

content/standards.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -359,13 +359,12 @@ Create the NextJS app:
359359

360360
```bash
361361
npx create-next-app@latest \
362+
--app \
362363
--ts \
363-
--tailwind \
364364
--eslint \
365-
--experimental-app \
366365
--src-dir \
367366
--import-alias @/* \
368-
--use pnpm \
367+
--use-pnpm \
369368
"${PFB_REPO}"
370369
```
371370

0 commit comments

Comments
 (0)