Skip to content
This repository was archived by the owner on Mar 5, 2026. It is now read-only.
This repository was archived by the owner on Mar 5, 2026. It is now read-only.

Add Documentation #41

@spotandjake

Description

@spotandjake

Currently we do not have any documentation given our goals with this project is to produce a website that can outgrow our time in the club it would be beneficial to document everything.

The main things I can think to document are:

  • Add Jsdoc to components (This has many benefits but shouldn't take very long)
  • Document how config.ts works (We just need some basic documentation theoretically anyone diving into this portion of the code will understand it but we want some basic onboarding info.
  • Document config.yaml, We want to document how the yaml works, both what each field means and all that info along with a basic intro to yaml. It would be beneficial if we used something like Zod Describe to add the descriptions and built a generator to generate this documentation so that our types and docs stay in sync otherwise the documentation will not be very useful.
  • Write a readme, we should write a good readme along with this.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions