Skip to content

Add a README for the project directory, remove unused apps#683

Merged
jchristgit merged 14 commits into
mainfrom
readme-for-project-directory
Feb 28, 2022
Merged

Add a README for the project directory, remove unused apps#683
jchristgit merged 14 commits into
mainfrom
readme-for-project-directory

Conversation

@jchristgit
Copy link
Copy Markdown
Contributor

Closes #676.

@jchristgit jchristgit added area: backend Related to internal functionality and utilities area: docs Adds or updates documentation priority: 1 - high High Priority level: 0 - beginner labels Feb 25, 2022
@jchristgit jchristgit requested a review from ks129 as a code owner February 25, 2022 00:13
@netlify
Copy link
Copy Markdown

netlify Bot commented Feb 25, 2022

✔️ Deploy Preview for pydis-static ready!

🔨 Explore the source changes: 9d5b0ba

🔍 Inspect the deploy log: https://app.netlify.com/sites/pydis-static/deploys/621d0255cb1f690008537d87

😎 Browse the preview: https://deploy-preview-683--pydis-static.netlify.app

@jchristgit jchristgit force-pushed the readme-for-project-directory branch from 10cd5f9 to 7fd19e4 Compare February 25, 2022 00:30
@coveralls
Copy link
Copy Markdown

coveralls commented Feb 25, 2022

Coverage Status

Coverage remained the same at 100.0% when pulling 9d5b0ba on readme-for-project-directory into 2846be8 on main.

Comment thread pydis_site/README.md Outdated
Comment thread pydis_site/README.md Outdated
Comment thread pydis_site/README.md
Comment thread pydis_site/README.md Outdated
@MarkKoz
Copy link
Copy Markdown
Contributor

MarkKoz commented Feb 25, 2022

I'm not sure if it's a good idea to use line breaks in Markdown. I prefer to rely on soft wrapping. Otherwise one has to rely on their text editor to fix the wrapping when something gets amended (or tediously do it manually). Maybe it's fair to blame one's editor if it cannot do this easily.

@jchristgit
Copy link
Copy Markdown
Contributor Author

I'm not sure if it's a good idea to use line breaks in Markdown. I prefer to rely on soft wrapping. Otherwise one has to rely on their text editor to fix the wrapping when something gets amended (or tediously do it manually). Maybe it's fair to blame one's editor if it cannot do this easily.

I personally prefer it for a few reasons:

  • It's easier to read it, for one in diffs and for the other when editing it

But I don't mind either way. I can kill off all the wrapping if we want, I will just hate it a little bit. What do you think?

@jchristgit jchristgit force-pushed the readme-for-project-directory branch from ecc0abb to 2e02f86 Compare February 26, 2022 12:32
Copy link
Copy Markdown
Contributor

@lemonsaurus lemonsaurus left a comment

Choose a reason for hiding this comment

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

I like this PR. 🥇

Your documentation is good, we're simplifying some things, and generally making this project easier to work with. Nice work. Will re-review once requests are addressed.

Comment thread pydis_site/README.md Outdated
Comment thread pydis_site/README.md Outdated
Comment thread pydis_site/README.md Outdated
Comment thread pydis_site/README.md Outdated
Comment thread pydis_site/README.md Outdated
Comment thread pydis_site/README.md Outdated
jchristgit and others added 6 commits February 26, 2022 15:03
Co-authored-by: Leon Sandøy <leon.haland@gmail.com>
Co-authored-by: Leon Sandøy <leon.haland@gmail.com>
Co-authored-by: Leon Sandøy <leon.haland@gmail.com>
Co-authored-by: Leon Sandøy <leon.haland@gmail.com>
Copy link
Copy Markdown
Contributor

@lemonsaurus lemonsaurus left a comment

Choose a reason for hiding this comment

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

Good, I'm 99% happy. I'll approve and leave the rest to you.

Comment thread pydis_site/README.md
Comment thread pydis_site/README.md Outdated
Co-authored-by: Mark <1515135+MarkKoz@users.noreply.github.com>
Co-authored-by: Leon Sandøy <leon.haland@gmail.com>
@jchristgit jchristgit requested a review from MarkKoz February 28, 2022 10:15
Copy link
Copy Markdown
Contributor

@janine9vn janine9vn left a comment

Choose a reason for hiding this comment

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

💯 This makes the project far more approachable, love this README. I now have a bit better of an idea of how to navigate this project and where to go to find what I need. No longer this black void that destroys hopes and dreams through sheer intimidation alone.

I think it would be nice here to link to site's contributing guidelines or just the landing Contributing page (https://www.pythondiscord.com/pages/guides/pydis-guides/contributing/).

@jchristgit
Copy link
Copy Markdown
Contributor Author

Thanks for the review!

I think it would be nice here to link to site's contributing guidelines or just the landing Contributing page (https://www.pythondiscord.com/pages/guides/pydis-guides/contributing/).

I've added this in the latest commit.

@jchristgit jchristgit enabled auto-merge February 28, 2022 17:12
@jchristgit jchristgit merged commit 193f0a9 into main Feb 28, 2022
@jchristgit jchristgit deleted the readme-for-project-directory branch February 28, 2022 17:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: backend Related to internal functionality and utilities area: docs Adds or updates documentation level: 0 - beginner priority: 1 - high High Priority

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create README for the project directory

5 participants