chore(docs): markdown linting and improved documentation #902
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for leapfrogai-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
This was
linked to
issues
Aug 12, 2024
…67-332-markdown-linting-and-improved-documentation
…67-332-markdown-linting-and-improved-documentation
|
For seeing the preview of the docs website, and use this every time you see a ref to the docs website during your review: https://deploy-preview-902--leapfrogai-docs.netlify.app/ For viewing the Markdowns uninterrupted: https://github.com/defenseunicorns/leapfrogai/tree/711-754-579-578-571-567-332-markdown-linting-and-improved-documentation |
alekst23
reviewed
Aug 15, 2024
alekst23
reviewed
Aug 15, 2024
…-and-improved-documentation
CollectiveUnicorn
requested changes
Aug 16, 2024
unicorn-kp
reviewed
Aug 19, 2024
jalling97
reviewed
Aug 19, 2024
CollectiveUnicorn
approved these changes
Aug 19, 2024
jalling97
approved these changes
Aug 19, 2024
justinthelaw
deleted the
711-754-579-578-571-567-332-markdown-linting-and-improved-documentation
branch
gscallon
reviewed
Aug 19, 2024
|
|
||
| :key: == Required by automation | ||
|
|
||
| 1. Drop a comment in any issue to let everyone know you're working on it and submit a Draft PR (step 4) as soon as you are able. |
There was a problem hiding this comment.
If allowed with the repository permissions, should they assign themselves to the issue as well?
|
|
||
| 5. :key: Automated tests will begin based on the paths you have edited in your Pull Request. | ||
|
|
||
| > ⚠️ **NOTE:** _If you are an external third-party contributor, the pipelines won't run until a [CODEOWNER](./CODEOWNERS) approves the pipeline run._ |
There was a problem hiding this comment.
How should contributors request this approval?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
OVERVIEW
An overhaul of the developer workflow. Updates to website documentation (UDS bundle latest, requirements, system specs), developer documentation (repo only) and workflows.
Secondary effects include standardizing language across the repository, README sections and wording, and making fixes to Makefile functionality and standardization (Makefile -> UDS Tasks, later), adding developer dependencies into sub-directories'
pyproject.tomlthat are missing them.NEW
UPDATED
pyproject.tomlmissing developer dependencies that are assumed installed