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 route for contributing on readme, and fixed a graphical bug on the badges at the top of the documentation #208

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

TimothyMalahy
Copy link
Member

  • I tried to move it to CONTRIBUTING.md to the same directory as code of conducts, readme, etc. I was optimistic it would appear in the region in red below, but I was mistaken.
    image

  • Moved the contents of contributing.MD to the readme.md let me know if you prefer it not be there.
    Other ideas I had

    • Contributing tab on the docs could link to the root/contributing.MD
    • Contributing could just be a section of the docs
  • Messed with the index.html for the docs regarding a bug for the badge for pypi downloads. The badge didn't link in that formatting on readthedocs specifically, found out a solution with &nbsp, but ultimately just copied from the github readme's syntax.

…or and badges for readme for developers and contributors to see it quickly. Also added in a &nbsp on the docs for the badges to fix the hyperlink pypi link
… as the other one was broken and this is uniform with the github link then
@cunla
Copy link
Member

cunla commented Jan 6, 2025

Hi,

Sorry for the late response. Why did you remove the content of the CONTRIBUTING.md file to the README?

GitHub uses this file in that location for contribution guidelines.

I thought you simply wanted to add a link to the file in the readme.

@TimothyMalahy
Copy link
Member Author

TimothyMalahy commented Jan 7, 2025

That was the link I was trying to find - but was not sure based off our previous back and forth so I just took a guess, as I didn't want to hassle you further. Sorry about that.

I'll adjust and add to this commit.

@TimothyMalahy TimothyMalahy changed the title docs: some docs and modified the index page of the docs slightly docs: Routing for contributing on readme, and fixed a graphical bug on the badges at the top of the documentation Jan 7, 2025
@TimothyMalahy TimothyMalahy changed the title docs: Routing for contributing on readme, and fixed a graphical bug on the badges at the top of the documentation docs: Added route for contributing on readme, and fixed a graphical bug on the badges at the top of the documentation Jan 7, 2025
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