Commit graph

85 commits

Author SHA1 Message Date
Clement Tsang
50768907ec
feature: add custom retention periods for data (#892)
* feature: add custom retention periods for data

* docs: update changelog

* docs: update docs
2022-11-13 01:51:10 -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
Clement Tsang
938c4ccd52
feature: search paste support (#881)
* feature: add pasting to search

Supports pasting events to the search bar (e.g. shift-insert, ctrl-shift-v).

* update docs

* clippy

* comment

* Update process.md

* remove keyboard event throttle

* fix issues with cjk/flag characters
2022-11-10 00:40:04 -05:00
Clement Tsang
e1be318177
docs: update usage and config, add blurb in home (#876)
* docs: update usage and config, add blurb in home

* add doc pages to pr template
2022-11-07 23:36:27 -05:00
Clement Tsang
76d2e83efa
docs: add a quick blurb on doc site of what bottom is (#875) 2022-11-07 02:44:30 -05:00
Clement Tsang
2b3c76bf5a
docs: update docs for disk sorting feature (#871)
* update changelog

* update mkdocs
2022-11-06 02:26:36 -05:00
Clement Tsang
4d9f5093b2
feature: basic sortable temp (#868)
* feature: basic sortable temp

* add shortcuts

* fix missing shortcut names in header

* update changelog

* update docs
2022-11-05 19:32:14 -04:00
Clement Tsang
99a353bade
docs: update docs lib versions as of 2022-10-29 (#857)
Updates the following document building libraries:

- `mkdocs` (1.3.1 -> 1.4.1)
- `mkdocs-material` (8.5.3 -> 8.5.7)
- `mkdocs-material-extensions` (1.0.3 -> 1.1.0)
2022-10-29 04:21:05 -04:00
Justin Martin
dd003101a0
enable gpu mem cli and update docs for arc/gpu mem (#836) 2022-10-16 00:08:38 -04:00
Clement Tsang
c4d164cfe1
docs: update mkdocs-material to 8.5.3 (#819) 2022-09-29 02:28:27 -04:00
ClementTsang
10efe75fbd
docs: update some contribution documentation 2022-09-16 05:16:58 -04:00
Clement Tsang
c6c7fb3a30
deps: update sysinfo to 0.26.2 (#806)
* deps: update sysinfo to 0.26.2

This dependency update has some nice things in store for us:
- MacOS M1 temperature support
- Bevy of bug fixes

* update documentation

* some fixes
2022-09-16 04:42:24 -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
1d0801ce71
docs: update mkdocs-material to 8.4.0 (#788) 2022-08-19 19:07:36 -04:00
ClementTsang
582cd308eb
docs: add half-page scroll shortcut to docs 2022-08-14 17:51:04 -04:00
ClementTsang
83284e2dba docs: edit docs regarding M1 macOS support 2022-08-13 11:31:29 -04:00
xgdgsc
bc74e0b73b
docs: fix dead link (#771) 2022-07-26 14:08:03 -04:00
Clement Tsang
39f04fb22c
docs: mention FreeBSD works (#769)
Update some documentation to mention (currently unofficialish) FreeBSD support.
2022-07-24 06:53:34 -04:00
Clement Tsang
31bd2ca19f
docs: bump mkdocs to fix markdown breaking exts (#770)
The markdown Python lib seems to be causing some issues with certain
extensions. Bumping mkdocs to 1.3.1 seems to resolve this issue (the
alternative is pinning markdown to < 8.4.0).
2022-07-24 06:50:52 -04:00
Clement Tsang
d3a187b529
docs: bump mkdocs-material to 8.3.9 (#762) 2022-07-07 05:30:49 -04:00
Clement Tsang
4fa1fc7f58
docs: bump mkdocs-material to 8.3.8 (#753)
Bumps mkdocs-material to 8.3.8, which contains some bug fixes.
2022-06-24 20:24:40 -04:00
Clement Tsang
372659094b
docs: bump mkdocs-material to 8.3.5 (#751)
Bumps mkdocs-material to 8.3.5 (https://github.com/squidfunk/mkdocs-material/releases/tag/8.3.5).
2022-06-15 03:46:48 -04:00
Clement Tsang
122373aff7
docs: bump mkdocs-material to 8.3.3 (#748)
Bumps mkdocs-material to version 8.3.3.

See https://github.com/squidfunk/mkdocs-material/releases/tag/8.3.3 for more details
2022-06-08 21:39:16 -04:00
Clement Tsang
c6ae6913fc
docs: bump mkdocs material to 8.2.15 (#735) 2022-05-23 20:11:21 -04:00
ClementTsang
45680dafcf docs: clean up troubleshooting page again 2022-05-07 20:01:11 -04:00
Clement Tsang
a26cffce05
docs: update mkdocs-material to 8.2.13 (#727) 2022-05-07 19:57:12 -04:00
ClementTsang
c09322fdc2 docs: add even more troubleshooting documentation 2022-05-07 19:48:32 -04:00
ClementTsang
4d507d1793 docs: add more troubleshooting documentation 2022-05-07 19:38:37 -04:00
Clement Tsang
08bb933f38
docs: add some search features to mkdocs config (#704)
Enables some search features for the mkdocs config.
2022-04-11 03:54:21 -04:00
Clement Tsang
7c62822732
docs: update mkdocs-material to 8.2.9 (#701) 2022-04-10 23:57:42 -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
1237a35663
docs: update app descriptions (#659)
Update app descriptions across the board to be more consistent.
2022-01-19 23:49:11 -05:00
Clement Tsang
f35718b580
docs: add section on WSL in Linux known issues, update links (#653)
Update support links in documentation; add section on WSL in Linux known issues.
2021-12-31 16:50:40 -05:00
Clement Tsang
9eabb061aa
feature: add basic page up/down scrolling (#646)
Adds page up/down scrolling support to respectively scroll up/down by a full page.

Note that this is mostly just to get the feature out for those interested, and is admittedly a bit rushed - I will be rewriting all logic involving event handling as part of state refactor anyways, so this will also get changed in the work done there, and therefore, I kinda just sped through this.
2021-12-27 18:23:11 -05:00
Clement Tsang
3fefcdbb11
docs: Update mkdocs file layout and config (#642)
Updates some settings regarding mkdocs. Main changes:

* Separate out support into two separate pages
* Move ToC as part of navigation
2021-12-22 18:03:33 -05:00
Clement Tsang
9a11ead991
ci: Use commit hash for some actions to pin them (#641)
Pins some actions using a specific commit hash.
2021-12-22 17:29:50 -05:00
Clement Tsang
78848ea968
docs: update mkdocs requirements (#634)
Updates the dependencies for mkdocs-related stuff.
2021-12-19 16:43:13 -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
a629e33f2d
docs: change contribution wording in docs page a bit (#614)
Tiny wording changes.
2021-11-27 06:41:54 -05:00
ClementTsang
175abf5db0 docs: small wording change 2021-11-27 05:31:32 -05:00
Clement Tsang
65d3dd7af5
ci: simplify python dependency step for release/doc pipeline (#596)
Slightly simplifies the whole Python dependency step for pipelines generating mkdocs.
2021-10-10 18:16:21 -04:00
ClementTsang
96ca024acc docs: break broken image link for sample layout 2021-09-25 22:11:10 -04:00
Clement Tsang
7e71832d10
bug: remove incorrect shortcut from docs/help (#589)
Removes an incorrect shortcut. No idea when that got there.
2021-09-25 20:28:41 -04:00
Clement Tsang
ed07fbe1cc
other: Make the battery dependency/features optional (#570)
Allows disabling of the battery dependency through a feature flag. This also aims to disable all related features.
2021-08-19 22:16:44 -04:00
Clement Tsang
f185c09c7e
docs: update home page text 2021-08-13 22:28:31 -04:00
Clement Tsang
2dddfcc962
docs: update edit link for doc site 2021-08-04 11:49:55 -04:00
ClementTsang
76cf7770f2 docs: fix typo 2021-07-31 16:25:38 -04:00