Commit Graph

14 Commits

Author SHA1 Message Date
Clement Tsang f8b8a21748 docs: use local link in docs to reference itself & missing CPU config (#1704)
* docs: use local link in docs to reference itself

* also fix missing cpu config docs
2025-03-28 04:22:40 +00:00
Clement Tsang dab4b6c483 other: master -> main (#1349)
* other: master -> main

I'm so used to using `main` branch now that it's actually kinda annoying
to use `master` for just this repo... so might as well rename it now.

* overzealous change

* wording

* some wording

* allow auto-cancel for tests if not main
2023-12-06 00:16:26 -05:00
Clement Tsang 036366274e docs: bump mike to v2.0.0 (#1318)
* bump mike

* bump some docs

* update some settings and serve script to use mike
2023-11-16 03:17:21 -05:00
Clement Tsang 04713bf81d docs: bump mkdocs-related dependencies to latest (#1317)
* docs: bump mkdocs-related dependencies to latest

bumps mkdocs-material to 9.4.8, mkdocs to 1.5.3, mkdocs-material-extensions to 1.3

* fix some link warnings
2023-11-16 02:45:04 -05:00
Yuri Astrakhan a6200640b9 chore: run spell and grammar checkers
* Chore: Run an spell cheker, and gramar cheker

* small revert

---------

Co-authored-by: Clement Tsang <34804052+ClementTsang@users.noreply.github.com>
2023-11-15 03:03:48 -05:00
Clement Tsang bce95c0d48 docs: update requirements.txt and bump to 3.11 (#1011) 2023-02-03 03:25:25 -05:00
Clement Tsang a94a8059da docs: add docs on process kill, update docs on updating docs (#1010)
* docs: add some documentation on process term, update captions

* docs on updating docs
2023-02-03 03:05:18 -05:00
Clement Tsang 5973e6db72 docs: adjust dev doc file structure, add build and deploy docs (#804)
* docs: add separate section on development

* docs: update instructions on writing docs

* docs: add build and deploy docs
2022-09-12 04:14:19 -04:00
Clement Tsang 747497cc8a docs: mention discussions, fix broken link, update mkdocs req (#698)
Fixes a broken link, and mention when to use discussions over issues. Also updates mkdocs in the build process due to some broken dependencies.
2022-03-27 21:57:55 -04:00
Clement Tsang a42b2cf6c8 docs: revert CFP for now (#633)
There were some weird interactions that I'm not sure about (like if you do bottom.pages.dev/asdf/ it infinitely redirects...?), so I'll revert for now.
2021-12-19 15:42:22 -05:00
Clement Tsang 8e5742d636 docs: try switching over to Cloudflare Pages (#632)
I would prefer for the project to not be under clementtsang.github.io/bottom, so let's try out CFP.
2021-12-19 15:26:10 -05:00
Clement Tsang 34541a4844 docs: update old documentation links (#522) 2021-06-24 00:13:24 -04:00
Clement Tsang b67c928f2b docs: Switch to mike for versioning (#521)
Switches to mike to add versioning to docs.
2021-06-23 23:34:39 -04:00
Clement Tsang 06071d5abf docs: migrate documentation over to mkdocs (#506)
A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs.

Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 01:40:58 -04:00