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

Cleanup documentation #67

Merged
merged 1 commit into from
Jan 31, 2024
Merged

Cleanup documentation #67

merged 1 commit into from
Jan 31, 2024

Conversation

rick-a-lane-ii
Copy link
Collaborator

Description

  • Cleans up existing documentation. This documentation needs expanded if we're going to continue to use custom runners, but for now this is just applying the bare-minimum, basic formatting, cleanliness and organization of markdown files.
  • Removes documentation referencing functionality that doesn't exist: i.e. "describes how this feature would work but it's not implemented." is never a good start.
  • Removes the scripts documentation, as it provides no helpful information.

Signed-off-by: Rick Lane <[email protected]>
@rick-a-lane-ii rick-a-lane-ii merged commit a375008 into main Jan 31, 2024
7 of 10 checks passed
@rick-a-lane-ii rick-a-lane-ii deleted the rlane/docs-cleanup branch January 31, 2024 20:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant