Documentation

Code

Typescript code should be documented using the TSDoc standard.

When writing documentation try to put yourself into the mindset of the next developer who will work on your code.

See

When incorporating code fragments from third party libraries always point back to the original documentation where possible. This gives other engineers more context when maintaining your code in the future.

@see - https://nextjs.org/docs/getting-started/installation

Example

If you think an implementation details will not be immediately obvious to another engineer then adding an example is helpful.

@example
\```
[ROUTES.catFacts]: {
    en-GB: ROUTES.catFacts,
    de-DE: "/Fakten über Katzen"
}
\```

Components

Documentation is handled with Storybook. Storybook can be run via yarn storybook from an application workspace.

Storybook documents both our custom components and themed MUI components.