icssc / icssc/docs

Centralized Calendar API Reference and Architecture

Open
#16 0 comments 0 reactions 1 assignee View on GitHub

@spicecat is already working on this.

Since Jun 9, 2024.

  • #17 by @josegonz115 — open
docs:addition
Dominant language
MDX
Stars
0
Forks
1
PR merge metrics
No merged PRs in 30d

Description

On the centralized-calendar branch, I have created stub files for API reference and architecture details.

The API reference page should cover details on how to query our API for ICS or JSON formatted events and all options. Write and format it as a typical API reference page. Stripe's API docs are a good reference.

Architecture details should cover a high level overview of how we query and store events, in addition to technologies used.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.