René's URL Explorer Experiment


Title: WIP Quick doc by LeoDaCoda · Pull Request #1608 · gitpython-developers/GitPython · GitHub

Open Graph Title: WIP Quick doc by LeoDaCoda · Pull Request #1608 · gitpython-developers/GitPython

X Title: WIP Quick doc by LeoDaCoda · Pull Request #1608 · gitpython-developers/GitPython

Description: Hey, this PR is in reference to an issue I raised. I would like to add a quick start guide to act as another resource for developers, I planned the guide to be mainly code snippets as opposed to a text based tutorial. I finished all the code and section headers I planned to add to the quick doc. I still want to add a few short sentences to improve readability. The tutorials includes how to do basic repo operations like init, clone, add, commit and push. Also shows how to iterate through the trees and print a text file. Where possible I tried to follow the conventions the regular tutorial followed (ie having the code snippets inside of the test file) but in some cases I had to add code directly to the RST (I did this to avoid having unnecessary print statements to the test suite). This is my first PR so forgive me if I did not follow propper conventions. Look forward to your feedback, Thanks!

Open Graph Description: Hey, this PR is in reference to an issue I raised. I would like to add a quick start guide to act as another resource for developers, I planned the guide to be mainly code snippets as opposed to a ...

X Description: Hey, this PR is in reference to an issue I raised. I would like to add a quick start guide to act as another resource for developers, I planned the guide to be mainly code snippets as opposed to a ...

Opengraph URL: https://github.com/gitpython-developers/GitPython/pull/1608

X: @github

direct link

Domain: github.com

route-pattern/:user_id/:repository/pull/:id/files(.:format)
route-controllerpull_requests
route-actionfiles
fetch-noncev2:5bf8e4a9-3de6-bbdf-bfdb-e75dcddd0af8
current-catalog-service-hashae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b
request-idB622:23E8C4:EFE94D:1438262:69688573
html-safe-nonce07995810a23641961b7b2add1e14506eda26798d0a75f10653b81263e5a50254
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCNjIyOjIzRThDNDpFRkU5NEQ6MTQzODI2Mjo2OTY4ODU3MyIsInZpc2l0b3JfaWQiOiI0MzAzNTY2MTQ0NDE3NTk2Nzg4IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0=
visitor-hmac5b65509827ee34c17e6d41578dbf9f1c53bdf4e3905ed6c93ebc9f89975634a1
hovercard-subject-tagpull_request:1426617884
github-keyboard-shortcutsrepository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///pull_requests/show/files
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/gitpython-developers/GitPython/pull/1608/files
twitter:imagehttps://avatars.githubusercontent.com/u/108432252?s=400&v=4
twitter:cardsummary_large_image
og:imagehttps://avatars.githubusercontent.com/u/108432252?s=400&v=4
og:image:altHey, this PR is in reference to an issue I raised. I would like to add a quick start guide to act as another resource for developers, I planned the guide to be mainly code snippets as opposed to a ...
og:site_nameGitHub
og:typeobject
hostnamegithub.com
expected-hostnamegithub.com
None50f46dc2d6192249fd8ebf20e76c800f4f2596d4a5f3ab63dd63a754df154f54
turbo-cache-controlno-preview
diff-viewunified
go-importgithub.com/gitpython-developers/GitPython git https://github.com/gitpython-developers/GitPython.git
octolytics-dimension-user_id503709
octolytics-dimension-user_logingitpython-developers
octolytics-dimension-repository_id1126087
octolytics-dimension-repository_nwogitpython-developers/GitPython
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id1126087
octolytics-dimension-repository_network_root_nwogitpython-developers/GitPython
turbo-body-classeslogged-out env-production page-responsive full-width
disable-turbotrue
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
releasefef287f17234b4529a4b112a3d47fe8551e32ddd
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/gitpython-developers/GitPython/pull/1608/files#start-of-content
https://github.com/
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fgitpython-developers%2FGitPython%2Fpull%2F1608%2Ffiles
GitHub CopilotWrite better code with AIhttps://github.com/features/copilot
GitHub SparkBuild and deploy intelligent appshttps://github.com/features/spark
GitHub ModelsManage and compare promptshttps://github.com/features/models
MCP RegistryNewIntegrate external toolshttps://github.com/mcp
ActionsAutomate any workflowhttps://github.com/features/actions
CodespacesInstant dev environmentshttps://github.com/features/codespaces
IssuesPlan and track workhttps://github.com/features/issues
Code ReviewManage code changeshttps://github.com/features/code-review
GitHub Advanced SecurityFind and fix vulnerabilitieshttps://github.com/security/advanced-security
Code securitySecure your code as you buildhttps://github.com/security/advanced-security/code-security
Secret protectionStop leaks before they starthttps://github.com/security/advanced-security/secret-protection
Why GitHubhttps://github.com/why-github
Documentationhttps://docs.github.com
Bloghttps://github.blog
Changeloghttps://github.blog/changelog
Marketplacehttps://github.com/marketplace
View all featureshttps://github.com/features
Enterpriseshttps://github.com/enterprise
Small and medium teamshttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
App Modernizationhttps://github.com/solutions/use-case/app-modernization
DevSecOpshttps://github.com/solutions/use-case/devsecops
DevOpshttps://github.com/solutions/use-case/devops
CI/CDhttps://github.com/solutions/use-case/ci-cd
View all use caseshttps://github.com/solutions/use-case
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
View all industrieshttps://github.com/solutions/industry
View all solutionshttps://github.com/solutions
AIhttps://github.com/resources/articles?topic=ai
Software Developmenthttps://github.com/resources/articles?topic=software-development
DevOpshttps://github.com/resources/articles?topic=devops
Securityhttps://github.com/resources/articles?topic=security
View all topicshttps://github.com/resources/articles
Customer storieshttps://github.com/customer-stories
Events & webinarshttps://github.com/resources/events
Ebooks & reportshttps://github.com/resources/whitepapers
Business insightshttps://github.com/solutions/executive-insights
GitHub Skillshttps://skills.github.com
Documentationhttps://docs.github.com
Customer supporthttps://support.github.com
Community forumhttps://github.com/orgs/community/discussions
Trust centerhttps://github.com/trust-center
Partnershttps://github.com/partners
GitHub SponsorsFund open source developershttps://github.com/sponsors
Security Labhttps://securitylab.github.com
Maintainer Communityhttps://maintainers.github.com
Acceleratorhttps://github.com/accelerator
Archive Programhttps://archiveprogram.github.com
Topicshttps://github.com/topics
Trendinghttps://github.com/trending
Collectionshttps://github.com/collections
Enterprise platformAI-powered developer platformhttps://github.com/enterprise
GitHub Advanced SecurityEnterprise-grade security featureshttps://github.com/security/advanced-security
Copilot for BusinessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/premium-support
Pricinghttps://github.com/pricing
Search syntax tipshttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
documentationhttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fgitpython-developers%2FGitPython%2Fpull%2F1608%2Ffiles
Sign up https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fpull_requests%2Fshow%2Ffiles&source=header-repo&source_repo=gitpython-developers%2FGitPython
Reloadhttps://github.com/gitpython-developers/GitPython/pull/1608/files
Reloadhttps://github.com/gitpython-developers/GitPython/pull/1608/files
Reloadhttps://github.com/gitpython-developers/GitPython/pull/1608/files
gitpython-developers https://github.com/gitpython-developers
GitPythonhttps://github.com/gitpython-developers/GitPython
Please reload this pagehttps://github.com/gitpython-developers/GitPython/pull/1608/files
Notifications https://github.com/login?return_to=%2Fgitpython-developers%2FGitPython
Fork 964 https://github.com/login?return_to=%2Fgitpython-developers%2FGitPython
Star 5k https://github.com/login?return_to=%2Fgitpython-developers%2FGitPython
Code https://github.com/gitpython-developers/GitPython
Issues 169 https://github.com/gitpython-developers/GitPython/issues
Pull requests 8 https://github.com/gitpython-developers/GitPython/pulls
Discussions https://github.com/gitpython-developers/GitPython/discussions
Actions https://github.com/gitpython-developers/GitPython/actions
Security Uh oh! There was an error while loading. Please reload this page. https://github.com/gitpython-developers/GitPython/security
Please reload this pagehttps://github.com/gitpython-developers/GitPython/pull/1608/files
Insights https://github.com/gitpython-developers/GitPython/pulse
Code https://github.com/gitpython-developers/GitPython
Issues https://github.com/gitpython-developers/GitPython/issues
Pull requests https://github.com/gitpython-developers/GitPython/pulls
Discussions https://github.com/gitpython-developers/GitPython/discussions
Actions https://github.com/gitpython-developers/GitPython/actions
Security https://github.com/gitpython-developers/GitPython/security
Insights https://github.com/gitpython-developers/GitPython/pulse
Sign up for GitHub https://github.com/signup?return_to=%2Fgitpython-developers%2FGitPython%2Fissues%2Fnew%2Fchoose
terms of servicehttps://docs.github.com/terms
privacy statementhttps://docs.github.com/privacy
Sign inhttps://github.com/login?return_to=%2Fgitpython-developers%2FGitPython%2Fissues%2Fnew%2Fchoose
Byronhttps://github.com/Byron
gitpython-developers:mainhttps://github.com/gitpython-developers/GitPython/tree/main
LeoDaCoda:quick_dochttps://github.com/LeoDaCoda/GitPython-QuickStart-Doc/tree/quick_doc
Conversation 42 https://github.com/gitpython-developers/GitPython/pull/1608
Commits 38 https://github.com/gitpython-developers/GitPython/pull/1608/commits
Checks 0 https://github.com/gitpython-developers/GitPython/pull/1608/checks
Files changed https://github.com/gitpython-developers/GitPython/pull/1608/files
Please reload this pagehttps://github.com/gitpython-developers/GitPython/pull/1608/files
WIP Quick doc https://github.com/gitpython-developers/GitPython/pull/1608/files#top
Show all changes 38 commits https://github.com/gitpython-developers/GitPython/pull/1608/files
97cdb40 Made the init repo section of quickdoc LeoDaCoda Jul 8, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/97cdb403fd11778916b006b22679f427a3c1a8ac
6a9154b Added git clone & git add LeoDaCoda Jul 9, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/6a9154b1bfcebe7ee28edebec6617993ad6a5569
3c42bae Finishing touches for Repo quickstart LeoDaCoda Jul 9, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/3c42baebf5bd7c509b9962d1490f59e8874f1323
10ea113 finished code for quickstart LeoDaCoda Jul 10, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/10ea113ca6141b8a74e78858e6ff6f52bfd04d9f
b0da0a9 finished code for quickstart LeoDaCoda Jul 10, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/b0da0a9e53a30dfcefaa7d77fe0bd0104b3a814e
fb35ed1 fixed some indentation LeoDaCoda Jul 10, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/fb35ed1d611113637c52a559d6f77aaadb6d403d
d42d82e Merge remote-tracking branch 'origin/quick_doc' into quick_doc LeoDaCoda Jul 10, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/d42d82ec3c7708dd2904284871bb2fdf9a21c5a9
47c8362 added quickstart to toctree and fixed sphinx warning LeoDaCoda Jul 10, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/47c83629cfa0550fae71f2c266bd8b236b63fdc6
b7955ed added quickstart to toctree to fix sphinx warning LeoDaCoda Jul 10, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/b7955ed1f1511dd7d873e4198b3372c104102b4f
4534f84 Merge remote-tracking branch 'origin/quick_doc' into quick_doc LeoDaCoda Jul 10, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/4534f849f4c298a926f2e6e39831aec33f7480fb
03d26f0 Removed code from RST LeoDaCoda Jul 10, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/03d26f0c92055759e296a36f2bde1ff9fb439b29
a0045d8 Made variable names more intuitive LeoDaCoda Jul 10, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/a0045d8844b937e703156adfbeb496ebc70c8950
9833655 Updated the sample repo URL LeoDaCoda Jul 10, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/98336551260f0b3093f5be085573b193198a4271
3cda530 removed try/except and updated sample url LeoDaCoda Jul 10, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/3cda530b1fc1e5ae3c2403a43a7270f6a73f07fb
e4bbc7a correct way to get the latest commit tree LeoDaCoda Jul 10, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/e4bbc7a520d83b7e5db208d0fe901cec0125c2f9
a1dfd4a convert from --all flag to all=True LeoDaCoda Jul 11, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/a1dfd4ade535242bb535cbda9b2f02153d2a423e
a8b5863 removed unnecessary variables LeoDaCoda Jul 11, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/a8b58639f57f5a4952f98ee097def5ad9543b566
abe7e6e replaced output cell to generic commit ID LeoDaCoda Jul 11, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/abe7e6e5075ba4b9ea4cfc74b6121ad977dc7e4f
1369bdc replaced hash with generic LeoDaCoda Jul 13, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/1369bdc6d7d06e473b7c211a4070dcee94438e64
9cd9431 draft of description LeoDaCoda Jul 13, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/9cd9431906acff137e441a2dd82d1d6d4e6322d7
393bae5 clarified comment LeoDaCoda Jul 13, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/393bae5184abda11cdaab128049fccba2fcb213f
aa6d27f refactored print git tree LeoDaCoda Jul 13, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/aa6d27f9204d68b21cd24366c8a58fb4f9578553
6d78ff1 Made trees and blobs the first section LeoDaCoda Jul 16, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/6d78ff1ac33fa2adeb0518feb33a634c09b0b5b5
2c9c0c1 Added warning about index add LeoDaCoda Jul 16, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/2c9c0c122d7dddce62d593f564d2b0c6f7a33e69
d276107 Updated generic sha hash LeoDaCoda Jul 16, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/d276107039d69bb3ad32595756b70fd4e51267d1
f3968f2 Removed all reference to source code LeoDaCoda Jul 16, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/f3968f2e34467735935ee7a39a7d2b2f07229e7d
9ca25d7 WIP major changes to structure to improve readability LeoDaCoda Jul 16, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/9ca25d767e554681ad9863138911800868c29b49
7fa57e5 Added new section to print prev file LeoDaCoda Jul 16, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/7fa57e5e30e56e7aa247cf77d1b84ddf5d08d1e7
9d878af change to formatting - removed = bash cmds LeoDaCoda Jul 17, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/9d878af964947a09e74f29e3a13b5a26d606e86f
315405d formatting wip LeoDaCoda Jul 17, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/315405d9395ff94348d43912d15471e6dd465100
bccf8bc added new section for diffs and formatting LeoDaCoda Jul 18, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/bccf8bc3ee2384048548e717e64a5d42156ba236
cad1e2e tabbed all code-blocks LeoDaCoda Jul 18, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/cad1e2e835b0b7876277c0514bcba2ac6fedab81
7e589f3 fixed tabbing LeoDaCoda Jul 18, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/7e589f3d852461e2c143035c1cc3ceb1a81ecd61
2a45f94 redundant line LeoDaCoda Jul 18, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/2a45f94d976e3cb91a7e700649eeea12f6655f7c
ef4d6d5 redundant code cell LeoDaCoda Jul 18, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/ef4d6d52fe02b7006224765cb65c824b8eca91e5
8138b3a generic hash LeoDaCoda Jul 18, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/8138b3a56d16f68cfe6a5d9371e2fde3d587161c
84885a3 added more resources section LeoDaCoda Jul 19, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/84885a3ea412261adf457aee1c6471606ba7095c
cf3a899 typo LeoDaCoda Jul 19, 2023 https://github.com/gitpython-developers/GitPython/pull/1608/commits/cf3a899ebd498bd8053bc17dab1ff4c36edc005e
Clear filters https://github.com/gitpython-developers/GitPython/pull/1608/files
Please reload this pagehttps://github.com/gitpython-developers/GitPython/pull/1608/files
Please reload this pagehttps://github.com/gitpython-developers/GitPython/pull/1608/files
index.rst https://github.com/gitpython-developers/GitPython/pull/1608/files#diff-1e3ed06e90fe3bf5ecf311ac1bd22215144cfc8c0924f5e05e3394573d630ceb
quickstart.rst https://github.com/gitpython-developers/GitPython/pull/1608/files#diff-68fc0aabf0343a84853c4e984faf7123f0a1bf7eff6596ecc371089419102720
test_quick_doc.py https://github.com/gitpython-developers/GitPython/pull/1608/files#diff-670228fbeb03ab4b850298b3bee9724458d1defef49f52e4a8ac8120e7d5aee7
doc/source/index.rsthttps://github.com/gitpython-developers/GitPython/pull/1608/files#diff-1e3ed06e90fe3bf5ecf311ac1bd22215144cfc8c0924f5e05e3394573d630ceb
View file https://github.com/LeoDaCoda/GitPython-QuickStart-Doc/blob/cf3a899ebd498bd8053bc17dab1ff4c36edc005e/doc/source/index.rst
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/gitpython-developers/GitPython/pull/1608/{{ revealButtonHref }}
https://github.com/gitpython-developers/GitPython/pull/1608/files#diff-1e3ed06e90fe3bf5ecf311ac1bd22215144cfc8c0924f5e05e3394573d630ceb
https://github.com/gitpython-developers/GitPython/pull/1608/files#diff-1e3ed06e90fe3bf5ecf311ac1bd22215144cfc8c0924f5e05e3394573d630ceb
doc/source/quickstart.rsthttps://github.com/gitpython-developers/GitPython/pull/1608/files#diff-68fc0aabf0343a84853c4e984faf7123f0a1bf7eff6596ecc371089419102720
View file https://github.com/LeoDaCoda/GitPython-QuickStart-Doc/blob/cf3a899ebd498bd8053bc17dab1ff4c36edc005e/doc/source/quickstart.rst
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/gitpython-developers/GitPython/pull/1608/{{ revealButtonHref }}
Please reload this pagehttps://github.com/gitpython-developers/GitPython/pull/1608/files
Please reload this pagehttps://github.com/gitpython-developers/GitPython/pull/1608/files
Please reload this pagehttps://github.com/gitpython-developers/GitPython/pull/1608/files
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width

URLs of crawlers that visited me.