Commit Graph

16 Commits

Author SHA1 Message Date
Clement Tsang 440e10c34d other: disable logging when building with default features (#1133)
* other: disable logging when building with default features

* update docs
2023-05-06 17:35:10 -04:00
ClementTsang a266dd74ec docs: update contributing docs/links 2023-02-13 03:35:46 -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
ClementTsang 32434932a6 docs: update some packaging/distribution docs with more details 2023-01-26 21:37:09 -05:00
Clement Tsang f41e7cd66d ci: unify cache keys in actions (#890)
* ci: unify cache keys in actions

* some docs

* because empty strings are false in JS

* update comment

* fix build cache naming
2022-11-11 23:45:27 -05:00
ClementTsang 10efe75fbd docs: update some contribution documentation 2022-09-16 05:16:58 -04: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 14808b3a2e ci: completion/manpage generation script spring cleaning (#795)
* ci: spring cleaning of completions autogen

This commit changes a few things/cleans up stuff:
- Completion and manpage generation now drops the files off in
  `./target/tmp/bottom` rather than arbitrarily in the build directory.
  This was originally done because I was lazy and just needed it to work
  in CI, but it's kinda gross if you want to build the manpages in your
  own directory.
- CI was updated to handle this.
- Only run if the `BTM_GENERATE` env var is actually non-empty.

* docs: update for manpage/completion gen

* ci: auto delete autogen comp/manpage dir

* ci: fix incorrect mv for autogen

The mv was too late, should be earlier in the workflow.

* ci: specify shell in autogen delete

* docs: more updates to manpage/comp docs

* ci: unify env vars

* ci: skip autogen on build-msi
2022-08-30 18:25:16 -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 61c8bfd574 docs: add a line to feature request docs/template (#666)
Just adds an extra line to the template/docs to check if an existing issue already exists.
2022-01-29 14:49:41 -05: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