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

Doc revisions1 #5621

Merged
merged 33 commits into from Mar 18, 2023
Merged

Doc revisions1 #5621

merged 33 commits into from Mar 18, 2023

Conversation

matteius
Copy link
Member

@matteius matteius commented Feb 26, 2023

Thank you for contributing to Pipenv!

The issue

The docs are long in need of work -- this is revision1 which tackles cleaning up the contents from the Basics and Advanced sections and splitting them apart. There were some bits left in advanced that I wasn't sure where to put them, so I left that section but renamed it to be other since most of the advanced information moved to other sections. I also added some context on the pipenv update and pipenv upgrade commands rework.

The fix

This is not the end-all be-all fix to the docs, no this is just progress. I plan to iterate on this more over time -- splitting apart advanced as well.

I was getting frustrated with rst files and found I was having better luck making the new sections markdown.

  • Removes the super old animation (we can make a new one, but I didn't want that old one holding us back longer)
  • Removes references to python3.6 and python 2 -- also just old weird misinformation in general removed.
  • Language updated to have a cohesive voice.

I am sure I missed some things and its definitely not perfect, but I think its an improvement.

The checklist

  • Associated issue
  • A news fragment in the news/ directory to describe this fix with the extension .bugfix.rst, .feature.rst, .behavior.rst, .doc.rst. .vendor.rst. or .trivial.rst (this will appear in the release changelog). Use semantic line breaks and name the file after the issue number or the PR #.

Pipfile Show resolved Hide resolved
Pipfile Show resolved Hide resolved
@matteius matteius requested a review from oz123 March 4, 2023 13:19
docs/commands.md Show resolved Hide resolved
docs/dev/indexes.md Outdated Show resolved Hide resolved
@matteius matteius requested a review from oz123 March 9, 2023 10:36
docs/pipfile.md Show resolved Hide resolved
@oz123 oz123 merged commit 761a03d into main Mar 18, 2023
@oz123 oz123 deleted the doc-revisions1 branch March 18, 2023 07:45
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.

None yet

2 participants