diff options
author | sudoforge <no-reply@sudoforge.com> | 2025-04-08 03:49:06 -0700 |
---|---|---|
committer | sudoforge <no-reply@sudoforge.com> | 2025-04-19 02:11:08 -0700 |
commit | 4b9583c5379121a65bfb3b0866b7bfd593d8f9f1 (patch) | |
tree | 4a095676de2c4934f9eda6d18919255489a2217f /bridge/gitlab/event_test.go | |
parent | 52f42daf8bf317a065277da50d916c90e26fe4dd (diff) | |
download | git-bug-I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce.tar.gz git-bug-I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce.zip |
docs: update install, contrib, and usage documentationI6f4b5f5ca73780cecf66a553cce80aa3f75df2ce
This change refactors documentation, especially //:README.md,
//:CONTRIBUTING.md, and centralized most of the rest of the contributing
and usage documentation into `//doc`.
Documentation changes focus on cleaning up erroneous language,
reformatting, and restructuring docs in order to reduce visual noise -
the goals are to enable users and contributors to find what they're looking
for much more quickly, reduce (sometimes erroneous) duplication, and
present a structured approach for where to put docs.
Additionally:
- Added CI pipeline badge for the `trunk` workflow in `//:README.md`
- Converted embedded emoji characters to GitHub's emoji syntax
- Moved most sections with image and installation instructions into
`<details>` elements
- Replaced references to gitter with matrix
- Introduced `treefmt-nix` to `devShells.default` in the flake, and all
non-generated documentation was formatted with `nix fmt` (running
`mdformat` under the hood)
- Regenerated //doc/md and //doc/man and refactored inline docs from various
pages that were iterating out command line details so that they simply
point to //doc/md instead
- Rewrote contributing docs to focus on using `nix`, to ensure that the
development shell is used. This enforces consistency across different
platforms with the revision and configuration of each tool we use, and
simplifies the onboarding story for contributors -- they only need to
install and configure nix (and optionally direnv). A dev container
will be provided in the future [0] as an alternative for users on
Windows (who can use WSL) or want to avoid installing `nix`.
[0]: https://github.com/git-bug/git-bug/issues/1364
Closes: #1212 #1276 #1330 #1357
Change-Id: I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce
Diffstat (limited to 'bridge/gitlab/event_test.go')
0 files changed, 0 insertions, 0 deletions