Skip to content

Update CONTRIBUTING.md broken links - #1276

Closed
sparr wants to merge 1 commit into
git-bug:masterfrom
sparr:patch-2
Closed

sparr wants to merge 1 commit into
git-bug:masterfrom
sparr:patch-2

Conversation

@sparr

@sparr sparr commented Oct 4, 2024

Copy link
Copy Markdown
Contributor

I'm not sure why this file uses the footnote-like markdown link syntax, but I tried to follow it when fixing the "without nix" link. I also removed the "how to clone" link that goes nowhere; maybe it was from an old version of the doc?

@github-actions

github-actions Bot commented Jan 2, 2025

Copy link
Copy Markdown

This bot triages pull requests in order to help the maintainers
identify what needs attention, according to the following lifecycle
rules:

  • After 90 days of inactivity, lifecycle/stale is applied
  • After 90 days of inactivity since lifecycle/stale was applied,
    lifecycle/rotten is applied

This bot will not automatically close stale pull requests.

To remove the stale status, you can:

  • Remove the stale label from this pull request
  • Comment on this issue
  • Close this issue
  • Offer to help out with triage and code review

To avoid automatic lifecycle management of this pull request, add
lifecycle/frozen.

@sparr

sparr commented Jan 2, 2025

Copy link
Copy Markdown
Contributor Author

This should still be reviewed and merged

Comment thread CONTRIBUTING.md
[install/nix]: https://nix.dev/install-nix
[install/direnv]: https://github.com/direnv/direnv/blob/master/docs/installation.md
[install/direnv/shell]: https://github.com/direnv/direnv/blob/master/docs/hook.md
[install/install-direnv-without-nix]: #user-content-install-direnv-without-nix

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[install/install-direnv-without-nix]: #user-content-install-direnv-without-nix
[install/install-direnv-without-nix]: #install-direnv-without-nix

i'm not quite sure where the user-content bit comes from (github's preview ui, maybe?); the above suggestion should work.

@sudoforge sudoforge added kind/bug Relates to an issue area/documentation Relates to general documentation and removed lifecycle/stale labels Apr 7, 2025
sudoforge added a commit that referenced this pull request Apr 19, 2025
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]: #1364

Closes: #1212 #1276 #1330 #1357
Change-Id: I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce
sudoforge added a commit that referenced this pull request Apr 19, 2025
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]: #1364

Closes: #1212 #1276 #1330 #1357
Change-Id: I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce
sudoforge added a commit that referenced this pull request Apr 19, 2025
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]: #1364

Closes: #1212 #1276 #1330 #1357
Change-Id: I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce
sudoforge added a commit that referenced this pull request Apr 19, 2025
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]: #1364

Closes: #1212 #1276 #1330 #1357
Change-Id: I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce
sudoforge added a commit that referenced this pull request Apr 19, 2025
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]: #1364

Closes: #1212 #1276 #1330 #1357
Change-Id: I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce
sudoforge added a commit that referenced this pull request Apr 19, 2025
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]: #1364

Closes: #1212 #1276 #1330 #1357
Change-Id: I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce
sudoforge added a commit that referenced this pull request May 2, 2025
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
- 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`.
- 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 added a commit that referenced this pull request May 2, 2025
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
- 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`.
- 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 added a commit that referenced this pull request May 2, 2025
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 added a commit that referenced this pull request May 2, 2025
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 added a commit that referenced this pull request May 5, 2025
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 added a commit that referenced this pull request May 5, 2025
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 added a commit that referenced this pull request May 5, 2025
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 added a commit that referenced this pull request May 5, 2025
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 added a commit that referenced this pull request May 5, 2025
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

Copy link
Copy Markdown
Contributor

Thanks for the contribution, @sparr! This was addressed in 96c7a11, which brought on many changes to the documentation (and is why i held off on this).

@sudoforge sudoforge closed this May 5, 2025
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/bug Relates to an issue

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants