1
|
{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"<code>bottom</code>","text":"<p>A customizable cross-platform graphical process/system monitor for the terminal, supporting Linux, macOS, and Windows. Inspired by other tools like gtop, gotop, and htop.</p> <p>This site serves as extended documentation for bottom alongside the <code>README.md</code>.</p> <p>Warning</p> <p>Some areas of this site are still in progress and may be missing details. Feel free to suggest/contribute changes!</p>"},{"location":"#installation","title":"Installation","text":"<p>Tip</p> <p>It's as good idea to first check out the Support page to see if your system is officially supported!</p> <p>Tip</p> <p>If you're facing some issues during/after installation, check out the Troubleshooting page for some common problems and solutions.</p> <p>To install bottom, refer to the installation section of the <code>README.md</code>, which contains a list of all the installation methods.</p>"},{"location":"#usage-and-configuration","title":"Usage and configuration","text":"<p>The command to run bottom is <code>btm</code>.</p> <p>You can refer to the usage pages for more details on using bottom (e.g. keybinds, some features, a general overview of what each widget does).</p> <p>To configure bottom (e.g. how it behaves, how it looks, etc.) refer to the command-line options page for temporary settings, or the config file page for more permanent settings.</p>"},{"location":"#contribution","title":"Contribution","text":"<p>New contributors are always welcome! See the contribution section for how to contribute to bottom, whether it be filing issues, writing documentation, creating pull requests, etc.</p>"},{"location":"troubleshooting/","title":"Troubleshooting","text":""},{"location":"troubleshooting/#the-graph-points-look-brokenstrange","title":"The graph points look broken/strange","text":"<p>It's possible that your graphs won't look great out of the box due to the reliance on braille fonts to draw them. One example of this is seeing a bunch of missing font characters, caused when the terminal isn't configured properly to render braille fonts.</p> <sub>An example of missing braille fonts in Powershell</sub> <p>One alternative is to use the <code>--dot_marker</code> option to render graph charts using dots instead of the braille characters, which generally seems better supported out of the box, at the expense of looking less intricate:</p> <sub>Example using <code>btm --dot_marker</code></sub> <p>Another (better) alternative is to install a font that supports braille fonts, and configure your terminal emulator to use it. For example, installing something like UBraille or Iosevka and ensuring your terminal uses it should work.</p>"},{"location":"troubleshooting/#braille-font-issues-on-linuxmacosunix-like","title":"Braille font issues on Linux/macOS/Unix-like","text":"<p>Generally, the problem comes down to you either not having a font that supports the braille markers, or your terminal emulator is not using the correct font for the braille markers.</p> <p>See here for possible fixes if you're having font issues on Linux, which may also be helpful for macOS or other Unix-like systems.</p> <p>If you're still having issues, feel free to open a discussion question about it.</p>"},{"location":"troubleshooting/#installing-fonts-for-windows-command-promptpowershell","title":"Installing fonts for Windows Command Prompt/PowerShell","text":"<p>Note: I would advise backing up your registry beforehand if you aren't sure what you are doing!</p> <p>Let's say you're installing Iosevka. The steps you can take are:</p> <ol> <li>Install the font itself.</li> <li>Open the registry editor, which you can do either by <code>Win+R</code> and opening <code>regedit</code>, or just opening it from the Start Menu.</li> <li> <p>In the registry editor, go to</p> <pre><code>HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Console\\TrueTypeFont\n</code></pre> </li> <li> <p>Here, add a new <code>String value</code>, and set the <code>Name</code> to a bunch of 0's (e.g. <code>000</code> - make sure the name isn't already used), then set the <code>Data</code> to the font name (e.g. <code>Iosevka</code>).</p> <p> <sub>The last entry is the new entry for Iosevka</sub> </p> </li> <li> <p>Then, open the Command Prompt/PowerShell, and right-click on the top bar, and open \"Properties\":</p> <p> </p> </li> <li> <p>From here, go to \"Font\", and set the font to your new font (so in this example, Iosevka):</p> </li> </ol>"},{"location":"troubleshooting/#why-cant-i-see-all-my-temperature-sensors-on-windows","title":"Why can't I see all my temperature sensors on Windows?","text":"<p>This is a known limitation, some sensors may require admin privileges to get sensor data.</p>"},{"location":"troubleshooting/#why-dont-i-see-dual-batteries-on-windows-reported-separately-eg-thinkpads","title":"Why don't I see dual batteries on Windows reported separately? (e.g. Thinkpads)","text":"<p>This is a known limitation which seems to be with how batteries are being detected on Windows.</p>"},{"location":"troubleshooting/#why-cant-i-see-all-my-temperature-sensors-on-wsl","title":"Why can't I see all my temperature sensors on WSL?","text":"<p>This is a known limitation with WSL. Due to how it works, hosts may not expose their temperature sensors and therefore, temperature sensors might be missing.</p>"},{"location":"troubleshooting/#why-does-wsl2-not-match-task-manager","title":"Why does WSL2 not match Task Manager?","text":"<p>This is a known limitation with WSL2. Due to how WSL2 works, the two might not match up in terms of reported data.</p>"},{"location":"troubleshooting/#why-cant-i-see-all-my-processesprocess-data-on-macos","title":"Why can't I see all my processes/process data on macOS?","text":"<p>This is a known limitation, and you may have to run the program with elevated privileges to work around it - for example:</p> <pre><code>sudo btm\n</code></pre> <p>Please note that you should be certain that you trust any software you grant root privileges.</p> <p>There are measures taken to try to maximize the amount of information obtained without elevated privileges. For example, one can modify the instructions found on the htop wiki on how to run htop without sudo for bottom. However, please understand the potential security risks before doing so!</p>"},{"location":"troubleshooting/#my-configuration-file-isnt-working","title":"My configuration file isn't working","text":"<p>If your configuration files aren't working, here are a few things to try:</p>"},{"location":"troubleshooting/#check-the-formatting","title":"Check the formatting","text":"<p>It may be handy to refer to the automatically generated config files or the sample configuration files. The config files also follow the TOML format.</p> <p>Also make sure your config options are under the right table - for example, to set your temperature type, you must set it under the <code>[flags]</code> table:</p> <pre><code>[flags]\ntemperature_type = \"f\"\n</code></pre> <p>Meanwhile, if you want to set a custom color scheme, it would be under the <code>[colors]</code> table:</p> <pre><code>[colors]\ntable_header_color=\"LightBlue\"\n</code></pre>"},{"location":"troubleshooting/#check-the-configuration-file-location","title":"Check the configuration file location","text":"<p>Make sure bottom is reading the right configuration file. By default, bottom looks for config files at these locations:</p> OS Default Config Location macOS <code>$HOME/Library/Application Support/bottom/bottom.toml</code> <code>~/.config/bottom/bottom.toml</code> <code>$XDG_CONFIG_HOME/bottom/bottom.toml</code> Linux <code>~/.config/bottom/bottom.toml</code> <code>$XDG_CONFIG_HOME/bottom/bottom.toml</code> Windows <code>C:\\Users\\<USER>\\AppData\\Roaming\\bottom\\bottom.toml</code> <p>If you want to use a config file in another location, use the <code>--config</code> or <code>-C</code> flags along with the path to the configuration file, like so:</p> <pre><code>btm -C path_to_config\n</code></pre>"},{"location":"troubleshooting/#my-installation-through-snap-has-some-widgets-that-are-blankshow-no-data","title":"My installation through snap has some widgets that are blank/show no data","text":"<p>Make sure bottom is given the correct permissions in order to collect data. Snapcraft explains how to do so, but the TL;DR is:</p> <pre><code>sudo snap connect bottom:mount-observe\nsudo snap connect bottom:hardware-observe\nsudo snap connect bottom:system-observe\nsudo snap connect bottom:process-control\n</code></pre>"},{"location":"configuration/command-line-options/","title":"Command-line Options","text":"<p>The following options can be provided to bottom in the command line to change the behaviour of the program. You can also see information on these options by running <code>btm -h</code>, or run <code>btm --help</code> to display more detailed information on each option:</p>"},{"location":"configuration/command-line-options/#general-options","title":"General Options","text":"Option Behaviour <code>--autohide_time</code> Temporarily shows the time scale in graphs. <code>-b, --basic</code> Hides graphs and uses a more basic look. <code>-C, --config <CONFIG PATH></code> Sets the location of the config file. <code>-t, --default_time_value <TIME></code> Default time value for graphs. <code>--default_widget_count <N></code> Sets the N'th selected widget type as the default. <code>--default_widget_type <WIDGET></code> Sets the default widget type, use <code>--help</code> for info. <code>--disable_click</code> Disables mouse clicks. <code>-m, --dot_marker</code> Uses a dot marker for graphs. <code>-e, --expanded</code> Expand the default widget upon starting the app. <code>--hide_table_gap</code> Hides spacing between table headers and entries. <code>--hide_time</code> Hides the time scale from being shown. <code>-r, --rate <TIME></code> Sets how often data is refreshed. <code>--retention <TIME></code> How far back data will be stored up to. <code>--show_table_scroll_position</code> Shows the scroll position tracker in table widgets. <code>-d, --time_delta <TIME></code> The amount of time changed upon zooming."},{"location":"configuration/command-line-options/#process-options","title":"Process Options","text":"Option Behaviour <code>-S, --case_sensitive</code> Enables case sensitivity by default. <code>-u, --current_usage</code> Calculates process CPU usage as a percentage of current usage rather than total usage. <code>--disable_advanced_kill</code> Hides additional stopping options Unix-like systems. <code>-g, --group_processes</code> Groups processes with the same name by default. <code>--mem_as_value</code> Defaults to showing process memory usage by value. <code>--process_command</code> Shows the full command name instead of the process name by default. <code>-R, --regex</code> Enables regex by default while searching. <code>-T, --tree</code> Makes the process widget use tree mode by default. <code>-n, --unnormalized_cpu</code> Show process CPU% usage without averaging over the number of CPU cores. <code>-W, --whole_word</code> Enables whole-word matching by default while searching."},{"location":"configuration/command-line-options/#temperature-options","title":"Temperature Options","text":"Option Behaviour <code>-c, --celsius</code> Use Celsius as the temperature unit. Default. <code>-f, --fahrenheit</code> Use Fahrenheit as the temperature unit. <code>-k, --kelvin</code> Use Kelvin as the temperature unit."},{"location":"configuration/command-line-options/#cpu-options","title":"CPU Options","text":"Option Behaviour <code>--cpu_left_legend</code> Puts the CPU chart legend on the left side. <code>-a, --hide_avg_cpu</code> Hides the average CPU usage entry."},{"location":"configuration/command-line-options/#memory-options","title":"Memory Options","text":"Option Behaviour <code>--enable_cache_memory</code> Enable collecting and displaying cache and buffer memory. <code>--memory_legend <POSITION></code> Where to place the legend for the memory chart widget."},{"location":"configuration/command-line-options/#network-options","title":"Network Options","text":"Option Behaviour <code>--network_legend <POSITION></code> Where to place the legend for the network chart widget. <code>--network_use_binary_prefix</code> Displays the network widget with binary prefixes. <code>--network_use_bytes</code> Displays the network widget using bytes. <code>--network_use_log</code> Displays the network widget with a log scale. <code>--use_old_network_legend</code> (DEPRECATED) Uses a separated network legend."},{"location":"configuration/command-line-options/#battery-options","title":"Battery Options","text":"Option Behaviour <code>--battery</code> Shows the battery widget in non-custom layouts."},{"location":"configuration/command-line-options/#gpu-options","title":"GPU Options","text":"Option Behaviour <code>--enable_gpu</code> Enable collecting and displaying GPU usage."},{"location":"configuration/command-line-options/#style-options","title":"Style Options","text":"Option Behaviour <code>--color <COLOR SCHEME></code> Use a color scheme, use <code>--help</code> for info."},{"location":"configuration/command-line-options/#other-options","title":"Other Options","text":"Option Behaviour <code>-h</code>, <code>--help</code> Prints help info (for more details use <code>--help</code>.) <code>-V</code>, <code>--version</code> Prints version information."},{"location":"configuration/config-file/","title":"Config File","text":"<p>For persistent configuration, and for certain configuration options, bottom supports config files.</p>"},{"location":"configuration/config-file/#default-config-file","title":"Default Config File","text":"<p>If no config file argument is given, it will automatically look for a config file at these locations:</p> OS Default Config Location macOS <code>$HOME/Library/Application Support/bottom/bottom.toml</code> <code>~/.config/bottom/bottom.toml</code> <code>$XDG_CONFIG_HOME/bottom/bottom.toml</code> Linux <code>~/.config/bottom/bottom.toml</code> <code>$XDG_CONFIG_HOME/bottom/bottom.toml</code> Windows <code>C:\\Users\\<USER>\\AppData\\Roaming\\bottom\\bottom.toml</code> <p>Like if a path is passed with <code>-C</code>/<code>--config</code>, if a file doesn't exist at the path, bottom will automatically create a new, default config file at that location.</p>"},{"location":"configuration/config-file/#json-schema","title":"JSON Schema","text":"<p>The configuration file also has JSON Schema support to make it easier to manage, if your IDE/editor supports it.</p>"},{"location":"configuration/config-file/cpu/","title":"CPU","text":""},{"location":"configuration/config-file/cpu/#default-cpu-graph-selection","title":"Default CPU Graph Selection","text":"<p>You can configure which CPU graph is shown by default when starting up bottom by setting <code>cpu.default</code>.</p> <pre><code>[cpu]\n# One of \"all\" (default), \"average\"/\"avg\"\ndefault = \"average\"\n</code></pre>"},{"location":"configuration/config-file/data-filtering/","title":"Data Filtering","text":"<p>Warning</p> <p>This section is in progress, and is just copied from the old documentation.</p> <p>You can hide specific disks, temperature sensors, and networks by name in the config file via <code>disk_filter</code> and <code>mount_filter</code>, <code>temp_filter</code>, and <code>net_filter</code> respectively. Regex (<code>regex = true</code>), case-sensitivity (<code>case_sensitive = true</code>), and matching only if the entire word matches (<code>whole_word = true</code>) are supported, but are off by default. Filters default to denying entries that match and can be toggled by setting <code>is_list_ignored</code> to <code>false</code> in the config file.</p> <p>For example, here's the disk widget with no filter:</p> <p></p> <p>The following in the config file would filter out some entries by disk name:</p> <pre><code>[disk_filter]\nis_list_ignored = true\nlist = [\"/dev/sda\"]\nregex = true\ncase_sensitive = false\nwhole_word = false\n</code></pre> <p></p> <p>If there are two potentially conflicting filters (i.e. when you are using both a disk and mount filter), the filter that explicitly allows an entry takes precedence over a filter that explicitly denies one. So for example, let's say we set a disk filter accepting anything with <code>/dev/sda</code>, but deny anything with <code>/mnt/.*</code> or <code>/</code>. So to do so, we write in the config file:</p> <pre><code>[disk_filter]\nis_list_ignored = false\nlist = [\"/dev/sda\"]\nregex = true\ncase_sensitive = false\nwhole_word = false\n\n[mount_filter]\nis_list_ignored = true\nlist = [\"/mnt/.*\", \"/\"]\nregex = true\ncase_sensitive = false\nwhole_word = true\n</code></pre> <p>This gives us:</p> <p></p>"},{"location":"configuration/config-file/flags/","title":"Flags","text":"<p>Warning</p> <p>This section is in progress, and is just copied from the old documentation.</p> <p>Most of the command line flags have config file equivalents to avoid having to type them out each time:</p> Field Type Functionality <code>hide_avg_cpu</code> Boolean Hides the average CPU usage. <code>dot_marker</code> Boolean Uses a dot marker for graphs. <code>cpu_left_legend</code> Boolean Puts the CPU chart legend to the left side. <code>current_usage</code> Boolean Sets process CPU% to be based on current CPU%. <code>group_processes</code> Boolean Groups processes with the same name by default. <code>case_sensitive</code> Boolean Enables case sensitivity by default. <code>whole_word</code> Boolean Enables whole-word matching by default. <code>regex</code> Boolean Enables regex by default. <code>basic</code> Boolean Hides graphs and uses a more basic look. <code>use_old_network_legend</code> Boolean DEPRECATED - uses the older network legend. <code>battery</code> Boolean Shows the battery widget. <code>rate</code> Unsigned Int (represents milliseconds) or String (represents human time) Sets a refresh rate in ms. <code>default_time_value</code> Unsigned Int (represents milliseconds) or String (represents human time) Default time value for graphs in ms. <code>time_delta</code> Unsigned Int (represents milliseconds) or String (represents human time) The amount in ms changed upon zooming. <code>hide_time</code> Boolean Hides the time scale. <code>temperature_type</code> String (one of [\"k\", \"f\", \"c\", \"kelvin\", \"fahrenheit\", \"celsius\"]) Sets the temperature unit type. <code>default_widget_type</code> String (one of [\"cpu\", \"proc\", \"net\", \"temp\", \"mem\", \"disk\"], same as layout options) Sets the default widget type, use --help for more info. <code>default_widget_count</code> Unsigned Int (represents which <code>default_widget_type</code>) Sets the n'th selected widget type as the default. <code>disable_click</code> Boolean Disables mouse clicks. <code>color</code> String (one of [\"default\", \"default-light\", \"gruvbox\", \"gruvbox-light\", \"nord\", \"nord-light\"]) Use a color scheme, use --help for supported values. <code>enable_cache_memory</code> Boolean Enable cache and buffer memory stats (not available on Windows). <code>mem_as_value</code> Boolean Defaults to showing process memory usage by value. <code>tree</code> Boolean Defaults to showing the process widget in tree mode. <code>show_table_scroll_position</code> Boolean Shows the scroll position tracker in table widgets. <code>process_command</code> Boolean Show processes as their commands by default. <code>disable_advanced_kill</code> Boolean Hides advanced options to stop a process on Unix-like systems. <code>network_use_binary_prefix</code> Boolean Displays the network widget with binary prefixes. <code>network_use_bytes</code> Boolean Displays the network widget using bytes. <code>network_use_log</code> Boolean Displays the network widget with a log scale. <code>enable_gpu</code> Boolean Shows the GPU widgets. <code>retention</code> String (human readable time, such as \"10m\", \"1h\", etc.) How much data is stored at once in terms of time. <code>unnormalized_cpu</code> Boolean Show process CPU% without normalizing over the number of cores. <code>expanded</code> Boolean Expand the default widget upon starting the app. <code>memory_legend</code> String (one of [\"none\", \"top-left\", \"top\", \"top-right\", \"left\", \"right\", \"bottom-left\", \"bottom\", \"bottom-right\"]) Where to place the legend for the memory widget. <code>network_legend</code> String (one of [\"none\", \"top-left\", \"top\", \"top-right\", \"left\", \"right\", \"bottom-left\", \"bottom\", \"bottom-right\"]) Where to place the legend for the network widget."},{"location":"configuration/config-file/layout/","title":"Layout","text":"<p>Warning</p> <p>This section is in progress, and is just copied from the old documentation.</p> <p>bottom supports customizable layouts via the config file. Currently, layouts are controlled by using TOML objects and arrays.</p> <p>For example, given the sample layout:</p> <pre><code>[[row]]\n [[row.child]]\n type=\"cpu\"\n[[row]]\n ratio=2\n [[row.child]]\n ratio=4\n type=\"mem\"\n [[row.child]]\n ratio=3\n [[row.child.child]]\n type=\"temp\"\n [[row.child.child]]\n type=\"disk\"\n</code></pre> <p>This would give a layout that has two rows, with a 1:2 ratio. The first row has only the CPU widget. The second row is split into two columns with a 4:3 ratio. The first column contains the memory widget. The second column is split into two rows with a 1:1 ratio. The first is the temperature widget, the second is the disk widget.</p> <p>This is what the layout would look like when run:</p> <p></p> <p>Each <code>[[row]]</code> represents a row in the layout. A row can have any number of <code>child</code> values. Each <code>[[row.child]]</code> represents either a column or a widget. A column can have any number of <code>child</code> values as well. Each <code>[[row.child.child]]</code> represents a widget. A widget is represented by having a <code>type</code> field set to a string.</p> <p>The following <code>type</code> values are supported:</p> <code>\"cpu\"</code> CPU chart and legend <code>\"mem\", \"memory\"</code> Memory chart <code>\"net\", \"network\"</code> Network chart and legend <code>\"proc\", \"process\", \"processes\"</code> Process table and search <code>\"temp\", \"temperature\"</code> Temperature table <code>\"disk\"</code> Disk table <code>\"empty\"</code> An empty space <code>\"batt\", \"battery\"</code> Battery statistics <p>Each component of the layout accepts a <code>ratio</code> value. If this is not set, it defaults to 1.</p> <p>Furthermore, you can have duplicate widgets.</p> <p>For an example, look at the default config, which contains the default layout.</p>"},{"location":"configuration/config-file/processes/","title":"Processes","text":""},{"location":"configuration/config-file/processes/#columns","title":"Columns","text":"<p>You can configure which columns are shown by the process widget by setting the <code>columns</code> setting:</p> <pre><code>[processes]\n# Pick which columns you want to use in any order.\ncolumns = [\"cpu%\", \"mem%\", \"pid\", \"name\", \"read\", \"write\", \"tread\", \"twrite\", \"state\", \"user\", \"time\", \"gmem%\", \"gpu%\"]\n</code></pre>"},{"location":"configuration/config-file/theming/","title":"Theming","text":"<p>Warning</p> <p>This section is in progress, and is just copied from the old documentation.</p> <p>The config file can be used to set custom colours for parts of the application under the <code>[colors]</code> object. The following labels are customizable with strings that are hex colours, RGB colours, or specific named colours.</p> <p>Supported named colours are one of the following strings: <code>Reset, Black, Red, Green, Yellow, Blue, Magenta, Cyan, Gray, DarkGray, LightRed, LightGreen, LightYellow, LightBlue, LightMagenta, LightCyan, White</code>.</p> Labels Details Example Table header colours Colour of table headers <code>table_header_color=\"255, 255, 255\"</code> CPU colour per core Colour of each core. Read in order. <code>cpu_core_colors=[\"#ffffff\", \"white\", \"255, 255, 255\"]</code> Average CPU colour The average CPU color <code>avg_cpu_color=\"White\"</code> All CPUs colour The colour for the \"All\" CPU label <code>all_cpu_color=\"White\"</code> RAM The colour RAM will use <code>ram_color=\"#ffffff\"</code> SWAP The colour SWAP will use <code>swap_color=\"#ffffff\"</code> RX The colour rx will use <code>rx_color=\"#ffffff\"</code> TX The colour tx will use <code>tx_color=\"#ffffff\"</code> Widget title colour The colour of the label each widget has <code>widget_title_color=\"#ffffff\"</code> Border colour The colour of the border of unselected widgets <code>border_color=\"#ffffff\"</code> Selected border colour The colour of the border of selected widgets <code>highlighted_border_color=\"#ffffff\"</code> Text colour The colour of most text <code>text_color=\"#ffffff\"</code> Graph colour The colour of the lines and text of the graph <code>graph_color=\"#ffffff\"</code> Cursor colour The cursor's colour <code>cursor_color=\"#ffffff\"</code> Selected text colour The colour of text that is selected <code>scroll_entry_text_color=\"#ffffff\"</code> Selected text background colour The background colour of text that is selected <code>scroll_entry_bg_color=\"#ffffff\"</code> High battery level colour The colour used for a high battery level (100% to 50%) <code>high_battery_color=\"green\"</code> Medium battery level colour The colour used for a medium battery level (50% to 10%) <code>medium_battery_color=\"yellow\"</code> Low battery level colour The colour used for a low battery level (10% to 0%) <code>low_battery_color=\"red\"</code> GPU colour per gpu Colour of each gpu. Read in order. <code>gpu_core_colors=[\"#ffffff\", \"white\", \"255, 255, 255\"]</code> ARC The colour ARC will use <code>arc_color=\"#ffffff\"</code>"},{"location":"contribution/documentation/","title":"Documentation","text":""},{"location":"contribution/documentation/#when-should-documentation-changes-be-done","title":"When should documentation changes be done?","text":"<ul> <li>Whenever a new feature is added, a bug is fixed, or a breaking change is made, it should be documented where appropriate (ex: <code>README.md</code>, changelog, etc.)</li> <li>New methods of installation are always appreciated and should be documented</li> </ul>"},{"location":"contribution/documentation/#what-pages-need-documentation","title":"What pages need documentation?","text":"<p>There are a few areas where documentation changes are often needed:</p> <ul> <li>The <code>README.md</code></li> <li>The help menu inside of the application (located here)</li> <li>The extended documentation (here)</li> <li>The <code>CHANGELOG.md</code></li> </ul>"},{"location":"contribution/documentation/#how-should-i-addupdate-documentation","title":"How should I add/update documentation?","text":"<ol> <li> <p>Fork the repository to make changes in.</p> </li> <li> <p>Where you're adding documentation will probably affect what you need to do:</p> <code>README.md</code> or <code>CHANGELOG.md</code> <p>For changes to <code>README.md</code> and <code>CHANGELOG.md</code>, just follow the formatting provided and use any editor.</p> <p>Generally, changes to <code>CHANGELOG.md</code> will be handled by a maintainer, and the contents of the file should follow the Keep a Changelog format, as well as link to the relevant PR or issues.</p> Help menu <p>For changes to the help menu, try to refer to the existing code within <code>src/constants.rs</code> on how the help menu is generated.</p> Extended documentation <p>For changes to the extended documentation, you'll probably want at least Python 3.11 (older and newer versions should be fine), MkDocs, Material for MkDocs, <code>mdx_truly_sane_lists</code>, and optionally Mike installed. These can help with validating your changes locally.</p> <p>You can do so through <code>pip</code> or your system's package managers. If you use <code>pip</code>, you can use venv to cleanly install the documentation dependencies:</p> <pre><code># Change directories to the documentation.\ncd docs/\n\n # Create venv, install the dependencies, and serve the page.\n./serve.sh\n</code></pre> <p>This will serve a local version of the docs that you can open on your browser. It will update as you make changes.</p> </li> <li> <p>Once you have your documentation changes done, submit it as a pull request. For more information regarding that, refer to Issues, Pull Requests, and Discussions.</p> </li> </ol>"},{"location":"contribution/issues-and-pull-requests/","title":"Issues, Pull Requests, and Discussions","text":""},{"location":"contribution/issues-and-pull-requests/#discussions","title":"Discussions","text":"<p>Discussions are open in the repo. As for the difference between discussions and issues:</p> <ul> <li>Open an issue if what you have enough information to properly fill out any details needed for a report or request.</li> <li>Open a discussion otherwise (e.g. asking a question).</li> </ul>"},{"location":"contribution/issues-and-pull-requests/#opening-an-issue","title":"Opening an issue","text":""},{"location":"contribution/issues-and-pull-requests/#bug-reports","title":"Bug reports","text":"<p>When filing a bug report, please use the bug report template and fill in as much as you can. It is incredibly difficult for a maintainer to fix a bug when it cannot be reproduced, and giving as much detail as possible generally helps to make it easier to reproduce the problem!</p>"},{"location":"contribution/issues-and-pull-requests/#feature-requests","title":"Feature requests","text":"<p>Please use the feature request template and fill it out. Remember to give details about what the feature is along with why you think this suggestion will be useful.</p> <p>Also, please check whether an existing issue has covered your specific feature request!</p>"},{"location":"contribution/issues-and-pull-requests/#pull-requests","title":"Pull requests","text":"<p>The expected workflow for a pull request is:</p> <ol> <li>Fork the project.</li> <li>Make your changes.</li> <li>Make any documentation changes if necessary - if you add a new feature, it'll probably need documentation changes. See here for tips on documentation.</li> <li>Commit and create a pull request to merge into the <code>main</code> branch. Please fill out the pull request template.</li> <li>Ask a maintainer to review your pull request.<ul> <li>Check if the CI workflow passes. These consist of clippy lints, rustfmt checks, and basic tests. If you are a first-time contributor, you may need to wait for a maintainer to let CI run.</li> <li>If changes are suggested or any comments are made, they should probably be addressed.</li> </ul> </li> <li>Once it looks good, it'll be merged! Note that generally, PRs are squashed to maintain repo cleanliness, though feel free to ask otherwise if that isn't preferable.</li> </ol>"},{"location":"contribution/packaging-and-distribution/","title":"Packaging and Distribution","text":"<p>Package maintainers are always welcome and appreciated! Here's some info on how one can help with package distribution and bottom.</p>"},{"location":"contribution/packaging-and-distribution/#pre-built-binaries","title":"Pre-built binaries","text":"<p>The latest stable release can be found here, where you can find pre-built binaries in either a <code>tar.gz</code> or <code>zip</code> format. Binaries here also include automatically generated shell completion files for zsh, bash, fish, and Powershell, which you may want to also install during the packaging process.</p> <p>You can also find a nightly build in the releases page, built every day at 00:00 UTC off of the <code>main</code> branch.</p> <p>In both cases, we use a combination of GitHub Actions and CirrusCI (mainly for FreeBSD and macOS M1) to create our release binaries. <code>build_releases.yml</code> contains the GitHub Action workflow used to do both of these, if reference is needed.</p>"},{"location"
|
