summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)Author
2022-09-16deps: update sysinfo to 0.26.2 (#806)Clement Tsang
* 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-12docs: adjust dev doc file structure, add build and deploy docs (#804)Clement Tsang
* docs: add separate section on development * docs: update instructions on writing docs * docs: add build and deploy docs
2022-08-30ci: completion/manpage generation script spring cleaning (#795)Clement Tsang
* 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-19docs: update mkdocs-material to 8.4.0 (#788)Clement Tsang
2022-08-14docs: add half-page scroll shortcut to docsClementTsang
2022-08-13docs: edit docs regarding M1 macOS supportClementTsang
2022-07-26docs: fix dead link (#771)xgdgsc
2022-07-24docs: mention FreeBSD works (#769)Clement Tsang
Update some documentation to mention (currently unofficialish) FreeBSD support.
2022-07-24docs: bump mkdocs to fix markdown breaking exts (#770)Clement Tsang
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-07docs: bump mkdocs-material to 8.3.9 (#762)Clement Tsang
2022-06-24docs: bump mkdocs-material to 8.3.8 (#753)Clement Tsang
Bumps mkdocs-material to 8.3.8, which contains some bug fixes.
2022-06-15docs: bump mkdocs-material to 8.3.5 (#751)Clement Tsang
Bumps mkdocs-material to 8.3.5 (https://github.com/squidfunk/mkdocs-material/releases/tag/8.3.5).
2022-06-08 docs: bump mkdocs-material to 8.3.3 (#748)Clement Tsang
Bumps mkdocs-material to version 8.3.3. See https://github.com/squidfunk/mkdocs-material/releases/tag/8.3.3 for more details
2022-05-23docs: bump mkdocs material to 8.2.15 (#735)Clement Tsang
2022-05-07docs: clean up troubleshooting page againClementTsang
2022-05-07docs: update mkdocs-material to 8.2.13 (#727)Clement Tsang
2022-05-07docs: add even more troubleshooting documentationClementTsang
2022-05-07docs: add more troubleshooting documentationClementTsang
2022-04-11docs: add some search features to mkdocs config (#704)Clement Tsang
Enables some search features for the mkdocs config.
2022-04-10docs: update mkdocs-material to 8.2.9 (#701)Clement Tsang
2022-03-27docs: mention discussions, fix broken link, update mkdocs req (#698)Clement Tsang
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-01-29docs: add a line to feature request docs/template (#666)Clement Tsang
Just adds an extra line to the template/docs to check if an existing issue already exists.
2022-01-19docs: update app descriptions (#659)Clement Tsang
Update app descriptions across the board to be more consistent.
2021-12-31docs: add section on WSL in Linux known issues, update links (#653)Clement Tsang
Update support links in documentation; add section on WSL in Linux known issues.
2021-12-27feature: add basic page up/down scrolling (#646)Clement Tsang
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-22docs: Update mkdocs file layout and config (#642)Clement Tsang
Updates some settings regarding mkdocs. Main changes: * Separate out support into two separate pages * Move ToC as part of navigation
2021-12-22ci: Use commit hash for some actions to pin them (#641)Clement Tsang
Pins some actions using a specific commit hash.
2021-12-19docs: update mkdocs requirements (#634)Clement Tsang
Updates the dependencies for mkdocs-related stuff.
2021-12-19docs: revert CFP for now (#633)Clement Tsang
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-19docs: try switching over to Cloudflare Pages (#632)Clement Tsang
I would prefer for the project to not be under clementtsang.github.io/bottom, so let's try out CFP.
2021-11-27docs: change contribution wording in docs page a bit (#614)Clement Tsang
Tiny wording changes.
2021-11-27docs: small wording changeClementTsang
2021-10-10ci: simplify python dependency step for release/doc pipeline (#596)Clement Tsang
Slightly simplifies the whole Python dependency step for pipelines generating mkdocs.
2021-09-25docs: break broken image link for sample layoutClementTsang
2021-09-25bug: remove incorrect shortcut from docs/help (#589)Clement Tsang
Removes an incorrect shortcut. No idea when that got there.
2021-08-19other: Make the battery dependency/features optional (#570)Clement Tsang
Allows disabling of the battery dependency through a feature flag. This also aims to disable all related features.
2021-08-13docs: update home page textClement Tsang
2021-08-04docs: update edit link for doc siteClement Tsang
2021-07-31docs: fix typoClementTsang
2021-07-31other: Add RISC-V to unofficially supported targets (#565)Clement Tsang
Adds CI actions and documentation for RISC-V.
2021-07-23change: add '/s' to network usage legend (#557)Clement Tsang
Adds "/s" to the the network usage graph legend.
2021-07-22docs: update a line in the docsClementTsang
2021-07-19docs: fix broken image link in data filtering (#553)Clement Tsang
Fixes broken links in the documentation site.
2021-07-17refactor: switch to manual implementation of meminfo parse (#548)Clement Tsang
Manually parse `/proc/meminfo` for the purposes of memory usage.
2021-07-17bug: switch over to procfs for linux mem usage (#547)Clement Tsang
Swap to manually calculating the mem total and usage via procfs. The usage calculation is now: total - (free + cached + buffers + slab_reclaimable - shmem) This follows the same usage calculation as htop. See the PR for more details.
2021-07-14bug: scaling -> scale in some docs, help, and config (#543)Clement Tsang
Just fixing a few typos.
2021-07-14bug: Fix missing config options in docs and default config (#542)Clement Tsang
Adds the missing hide_time and battery config option to the default config and corresponding documentation. Should probably automate the generation of this somehow tbh, though this might change when I add in-app config (soon™)
2021-07-01docs: Fix typo and clarify in troubleshooting step for points (#532)Clement Tsang
2021-06-27docs: Fix typoClementTsang
2021-06-27docs: Add a section in troubleshooting on snapClementTsang