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: Added Arch Linux commands to contributing guideline and various minor changes #437

Merged
merged 8 commits into from
Oct 24, 2024

Conversation

shirsakm
Copy link
Contributor

I have added the commands to be run on Arch Linux for setting up the project when contributing, and other minor changes.

Here is a list of the changes I have made,

Added Arch Linux commands

Added a step to add a virtual environment

I find this to be an important step as otherwise there could be dependency conflicts which would result in issues being opened, which are unrelated to the project completely. Moreover, it can be hard to diagnose sometimes.

Moved the important note above the poetry install step

The system packages have to be installed before, and having it afterwards can result in it being missed.

Added $ in front of the commands

It is the standard way to represent a bash prompt, and helps distinguish the various commands, improving readability.

Moved the Python version requirement into a note.

Please let me know if there are any issues, or any edits that go against the formatting guidelines.

@shirsakm
Copy link
Contributor Author

Implements the changes as mentioned in #408

@shirsakm
Copy link
Contributor Author

Btw, I believe a tag needs to be added for this PR to count towards Hacktoberfest.

@tomlin7 tomlin7 merged commit 1526672 into tomlin7:main Oct 24, 2024
4 of 5 checks passed
@shirsakm
Copy link
Contributor Author

shirsakm commented Oct 24, 2024

Just wanted to mention, was the including of the code blocks in the code blocks intended?
Also, the usage of !!! instead of [!NOTE] is certainly an interesting choice, any particular reasons for the change?

@tomlin7
Copy link
Owner

tomlin7 commented Oct 26, 2024

@shirsakm you might've noticed the mkdocs config in the root directory, /docs/ is deployed using mkdocs here: https://tomlin7.github.io/biscuit/

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.

2 participants