Skip to content

docs: update install, contrib, and usage documentation#1222

Merged
sudoforge merged 1 commit intomasterfrom
I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce
May 5, 2025
Merged

docs: update install, contrib, and usage documentation#1222
sudoforge merged 1 commit intomasterfrom
I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce

Conversation

@sudoforge
Copy link
Contributor

@sudoforge sudoforge commented Aug 2, 2024

This change refactors documentation, especially //:README.md,
//:CONTRIBUTING.md, and centralized most of the rest of the contributing
and usage documentation into //doc. There are some additional minor
changes to the development shell and pipeline configuration.

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
  • Simplified //:README.md by moving inline documentation out to files
    under //doc.
  • Removed most inline CLI "documentation" (lists of commands) with a
    link to the generated CLI documentation.
  • Moved most sections with image and installation instructions into
    <details> elements
  • Replaced references to gitter with matrix
  • Added treefmt-nix to the flake, and formatted all non-generated
    documentation was 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.
  • Added pinact to the flake to support pinning action libraries used
    in workflows.
  • Added flake checks for codespell and pinact. Combined with treefmt,
    this entirely replaces //.github/workflows:lint.yml. With this change,
    codespell's execution was fixed to properly execute on all files, and
    the configuration file was refactored to properly ignore
    package-lock.json files.
  • Added a workflow job to run flake checks.

Closes: #1212 #1276 #1330 #1357
Change-Id: I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce

@sudoforge sudoforge force-pushed the I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce branch 30 times, most recently from 1f86323 to 5abecac Compare August 4, 2024 03:10
@sudoforge sudoforge force-pushed the I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce branch from 1e2fdae to ceccae6 Compare April 19, 2025 07:53
@sudoforge sudoforge marked this pull request as ready for review April 19, 2025 07:53
@sudoforge sudoforge enabled auto-merge April 19, 2025 07:53
@sudoforge sudoforge force-pushed the I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce branch from ceccae6 to cd8393b Compare April 19, 2025 07:55
@sudoforge sudoforge disabled auto-merge April 19, 2025 07:56
@sudoforge sudoforge force-pushed the I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce branch from cd8393b to 042b844 Compare April 19, 2025 08:18
@sudoforge sudoforge enabled auto-merge April 19, 2025 08:18
@sudoforge sudoforge disabled auto-merge April 19, 2025 08:19
@sudoforge sudoforge force-pushed the I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce branch from 042b844 to 222f4af Compare April 19, 2025 08:39
@sudoforge sudoforge enabled auto-merge April 19, 2025 08:39
@sudoforge sudoforge closed this Apr 19, 2025
auto-merge was automatically disabled April 19, 2025 08:42

Pull request was closed

@sudoforge sudoforge force-pushed the I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce branch from 222f4af to 25f755c Compare April 19, 2025 08:42
@sudoforge sudoforge reopened this Apr 19, 2025
@sudoforge sudoforge force-pushed the I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce branch from 4b9583c to 7fde4db Compare May 2, 2025 21:41
@sudoforge sudoforge enabled auto-merge May 2, 2025 21:41
@sudoforge sudoforge force-pushed the I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce branch 6 times, most recently from 9fc8eca to b85e52c Compare May 5, 2025 22:07
This change refactors documentation, especially //:README.md,
//:CONTRIBUTING.md, and centralized most of the rest of the contributing
and usage documentation into `//doc`. There are some additional minor
changes to the development shell and pipeline configuration.

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
- Simplified `//:README.md` by moving inline documentation out to files
  under `//doc`.
- Removed most inline CLI "documentation" (lists of commands) with a
  link to the generated CLI documentation.
- Moved most sections with image and installation instructions into
  `<details>` elements
- Replaced references to gitter with matrix
- Added `treefmt-nix` to the flake, and formatted all non-generated
  documentation was 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`.
- Added `pinact` to the flake to support pinning action libraries used
  in workflows.
- Added flake checks for codespell and pinact. Combined with treefmt,
  this entirely replaces //.github/workflows:lint.yml. With this change,
  codespell's execution was fixed to properly execute on all files, and
  the configuration file was refactored to properly ignore
  package-lock.json files.
- Added a workflow job to run flake checks.

[0]: #1364

Closes: #1212 #1276 #1330 #1357
Change-Id: I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce
@sudoforge sudoforge force-pushed the I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce branch from b85e52c to 6d33331 Compare May 5, 2025 22:31
@sudoforge sudoforge disabled auto-merge May 5, 2025 22:41
@sudoforge sudoforge merged commit 96c7a11 into master May 5, 2025
14 checks passed
@sudoforge sudoforge deleted the I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce branch May 5, 2025 22:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation Relates to general documentation kind/feature Relates to a new feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update documentation

1 participant