Skip to content

Development guide fixes#284

Merged
arm4b merged 4 commits intomainfrom
docs/dev-guide-fix
Aug 22, 2022
Merged

Development guide fixes#284
arm4b merged 4 commits intomainfrom
docs/dev-guide-fix

Conversation

@arm4b
Copy link
Copy Markdown
Contributor

@arm4b arm4b commented Aug 19, 2022

This PR removes outdated v1.0 code structure from the development guide documentation, updates the list of installed core BitOps packages, and also fixes various minor issues like grammar, typos, missing links, formatting, etc.

arm4b added 3 commits August 18, 2022 22:38
Remove references to the libraries and pip packages in requirements.txt as those can quickly become outdated.

Mention the binaries only, important for the user.
@arm4b arm4b added bug 🪲 Something isn't working documentation 📗 Improvements or additions to documentation enhancement ✨ New feature or request labels Aug 19, 2022
@arm4b arm4b requested a review from ccapell August 19, 2022 14:28
Comment on lines +83 to -88
### Standard BitOps Packages

### Standard BitOps Packages and Libraries:

System Packages natively available in a running BitOps container:
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

A note here is that we should mention the usable binaries only, which are really important for the user and skip everything else.

References to the libraries and pip packages in requirements.txt can quickly become outdated and it's just a noise for the user.

@arm4b arm4b changed the title Developer guide fixes Development guide fixes Aug 19, 2022
@arm4b arm4b merged commit 99cd1d1 into main Aug 22, 2022
@arm4b arm4b deleted the docs/dev-guide-fix branch August 22, 2022 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug 🪲 Something isn't working documentation 📗 Improvements or additions to documentation enhancement ✨ New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants