From bd04fbdb5b76af00d5832eb8ceebac31c74fca52 Mon Sep 17 00:00:00 2001 From: Abhijit Gupta Date: Sat, 25 Nov 2023 13:46:16 -0500 Subject: [PATCH] Update Docs (#239) --- docs/API.md | 32 ++++++++++++++++---------------- docs/CONTRIBUTING.md | 22 ++-------------------- 2 files changed, 18 insertions(+), 36 deletions(-) diff --git a/docs/API.md b/docs/API.md index cd1b5b74..9cd7ccda 100644 --- a/docs/API.md +++ b/docs/API.md @@ -49,14 +49,14 @@ https://api.githubtrends.io/user/svg/{user_id}/langs The following customization options are available: -| Option | Description | Default | -| ----------------- | -------------------------------------------------------------------------------------------------------------------------------- | ----------- | -| `time_range` | Specifies the time range to query statistics for. Valid options are `one_month`, `three_months`, `six_months`, and `one_year`. | `one_month` | -| `include_private` | Determines if private contributions are included (requires private workflow). | `false` | -| `compact` | Determines if compact layout is used (forces percentages over LOC) | `false` | -| `use_percent` | Valid if `compact=false`, determines if line of code (default) or percentages are displayed. | `false` | -| `loc_metric` | Options are LOC added (`added`) and LOC changed (`changed`). | `added` | -| `theme` | Theme to use for the card. See [docs/THEME.md](https://github.com/avgupta456/github-trends/blob/main/docs/THEME.md) for options. | `classic` | +| Option | Description | Default | +| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ----------- | +| `time_range` | Specifies the time range to query statistics for. Valid options are `one_month`, `three_months`, `six_months`, `one_year`, and `all_time`. | `one_month` | +| `include_private` | Determines if private contributions are included (requires private workflow). | `false` | +| `compact` | Determines if compact layout is used (forces percentages over LOC) | `false` | +| `use_percent` | Valid if `compact=false`, determines if line of code (default) or percentages are displayed. | `false` | +| `loc_metric` | Options are LOC added (`added`) and LOC changed (`changed`). | `added` | +| `theme` | Theme to use for the card. See [docs/THEME.md](https://github.com/avgupta456/github-trends/blob/main/docs/THEME.md) for options. | `classic` | Customizations can be appended to the endpoint, separated first with `?` and subsequently with `&`. @@ -78,14 +78,14 @@ https://api.githubtrends.io/user/svg/{user_id}/repos The following customization options are available: -| Option | Description | Default | -| ----------------- | -------------------------------------------------------------------------------------------------------------------------------- | ----------- | -| `time_range` | Specifies the time range to query statistics for. Valid options are `one_month`, `three_months`, `six_months`, and `one_year`. | `one_month` | -| `include_private` | Determines if private contributions are included (requires private workflow). | `false` | -| `group` | Options are `none` (default), `other` (group all other repos together), and `private` (force private repos to be grouped) | `none` | -| `use_percent` | Valid if `compact=false`, determines if line of code (default) or percentages are displayed. | `false` | -| `loc_metric` | Options are LOC added (`added`) and LOC changed (`changed`). | `added` | -| `theme` | Theme to use for the card. See [docs/THEME.md](https://github.com/avgupta456/github-trends/blob/main/docs/THEME.md) for options. | `classic` | +| Option | Description | Default | +| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ----------- | +| `time_range` | Specifies the time range to query statistics for. Valid options are `one_month`, `three_months`, `six_months`, `one_year`, and `all_time`. | `one_month` | +| `include_private` | Determines if private contributions are included (requires private workflow). | `false` | +| `group` | Options are `none` (default), `other` (group all other repos together), and `private` (force private repos to be grouped) | `none` | +| `use_percent` | Valid if `compact=false`, determines if line of code (default) or percentages are displayed. | `false` | +| `loc_metric` | Options are LOC added (`added`) and LOC changed (`changed`). | `added` | +| `theme` | Theme to use for the card. See [docs/THEME.md](https://github.com/avgupta456/github-trends/blob/main/docs/THEME.md) for options. | `classic` | Customizations can be appended to the endpoint, separated first with `?` and subsequently with `&`. diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index aecb9615..6249a40d 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -14,28 +14,10 @@ docker-compose up --build -d ### Manual -With Python3.11, install the dependencies from `backend/requirements.txt` and run on two separate terminal windows +With Python3.11, install the dependencies from `backend/requirements.txt` and run `yarn start`. -``` -yarn start-sub -yarn start-pub -``` - -With Node16 and Yarn, install the dependencies from `frontend/package.json` and run on a separate terminal window - -``` -yarn start -``` +With Node16 and Yarn, install the dependencies from `frontend/package.json` and run on a separate terminal window `yarn start`. ## Testing Create a pull request and let GitHub Actions run. Alternatively, explore `.github/backend.yaml` and `.github/frontend.yaml` to run tests locally. Backend coverage must increase for PRs to be merged. - -## FAQ - -(In Progress) - -## Action Items - -1. Create Development/Test containers that do not require secrets. -2. FAQ