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

Update repo README design #2000

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

vahram-papazyan
Copy link

@vahram-papazyan vahram-papazyan commented Aug 5, 2023

Hello, I decided to update the README design a bit. Hope you will like it.


📚 Documentation preview 📚: https://writethedocs-www--2000.org.readthedocs.build/

@vahram-papazyan vahram-papazyan marked this pull request as ready for review August 5, 2023 13:35
@ericholscher ericholscher requested a review from a team January 29, 2024 23:03
### Code Architecture
## ⬅ Prerequisites for generating the docs locally

1. Install `python 3.8.x` using your package manager, if not installed already. You'll probably need `root` privileges to do this.
Copy link
Contributor

Choose a reason for hiding this comment

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

It's not exclusively 3.8 though - I think we support 3.7 and up?

Copy link
Contributor

Choose a reason for hiding this comment

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

But it keeps the instructions more straightforward. If this is the only issue, let's get this merged?

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm gonna merge this :-D

@plaindocs plaindocs enabled auto-merge (squash) July 31, 2024 15:44
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.

4 participants