Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: refactor installation and usage documentation #1222

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

sudoforge
Copy link
Collaborator

@sudoforge sudoforge commented Aug 2, 2024

This change cleans up erroneous language and formatting in //:README.md,
adds explicit installation documentation under //:INSTALLATION.md, and
moves usage documentation to //doc.

  • Added CI pipeline badge for the trunk workflow
  • 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

Closes: #1212
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 e515903 to f9c6345 Compare August 4, 2024 04:35
@sudoforge sudoforge marked this pull request as ready for review August 4, 2024 04:35
@sudoforge sudoforge marked this pull request as draft August 4, 2024 18:01
@sudoforge sudoforge force-pushed the I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce branch from f9c6345 to 11b3d97 Compare August 6, 2024 14:34
@sudoforge sudoforge changed the title docs: clean up readme docs: refactor installation and usage documentation Aug 6, 2024
@sudoforge sudoforge force-pushed the I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce branch 7 times, most recently from 3141185 to 7fa5cf0 Compare August 8, 2024 00:12
This is a temporary change in this tree, so that the relevant pipelines
do not run for each commit. It should not be committed to trunk.

Change-Id: I570470e8d81c4bb8827086e332602042c618e5fa
@sudoforge sudoforge force-pushed the I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce branch 13 times, most recently from 9612336 to 992195a Compare August 26, 2024 00:56
This change cleans up erroneous language and formatting in //:README.md,
adds explicit installation documentation under //:INSTALLATION.md, and
moves usage documentation to //doc.

- Added CI pipeline badge for the `trunk` workflow
- 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

Closes: #1212
Change-Id: I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce
@sudoforge sudoforge force-pushed the I6f4b5f5ca73780cecf66a553cce80aa3f75df2ce branch from 992195a to 12e8954 Compare August 26, 2024 00:57
Copy link

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.

@github-actions github-actions bot added the lifecycle/stale Inactive for 90d or more label Nov 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lifecycle/stale Inactive for 90d or more
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refactor documentation related to community rooms (e.g. gitter -> matrix)
1 participant