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: refine quick start #487

Merged
merged 13 commits into from
May 13, 2024
Merged

docs: refine quick start #487

merged 13 commits into from
May 13, 2024

Conversation

aorumbayev
Copy link
Collaborator

@aorumbayev aorumbayev commented Apr 25, 2024

Addresses #486

Proposed Changes

  • Refreshing quick start page
  • Patching ci, macos-latest is now arm by default, adding intel explicitly

@aorumbayev aorumbayev requested review from Loedn and robdmoore April 25, 2024 10:59
Copy link

github-actions bot commented Apr 25, 2024

Coverage

Coverage Report
FileStmtsMissCoverMissing
src/algokit
   __init__.py15753%6–13, 17–24, 32–34
   __main__.py440%1–7
src/algokit/cli
   __init__.py47394%31–34
   completions.py108992%63–64, 83, 93–99
   dispenser.py121199%77
   doctor.py49394%143–145
   explore.py501276%34–39, 41–46
   generate.py70396%76–77, 155
   goal.py44198%71
   init.py3092492%493–494, 499–500, 503, 524, 527–529, 540, 544, 602, 628, 657, 690, 699–701, 704–709, 722, 741, 753–754
   localnet.py1191587%74–78, 111, 123, 138–148, 161, 206, 227–228
   task.py34391%25–28
src/algokit/cli/common
   utils.py26292%120, 123
src/algokit/cli/project
   bootstrap.py32197%33
   deploy.py992080%47, 49, 101, 124, 146–148, 227, 234, 248–256, 259–268
   link.py891682%60, 65–66, 101–105, 115–120, 148–149, 218–219, 223
   list.py33585%21–23, 51–56
   run.py46393%38, 71, 160
src/algokit/cli/tasks
   analyze.py81199%81
   assets.py821384%65–66, 72, 74–75, 105, 119, 125–126, 132, 134, 136–137
   ipfs.py51884%52, 80, 92, 94–95, 105–107
   mint.py66494%48, 70, 91, 250
   send_transaction.py651085%52–53, 57, 89, 158, 170–174
   sign_transaction.py59886%21, 28–30, 71–72, 109, 123
   transfer.py39392%26, 90, 117
   utils.py994555%26–34, 40–43, 75–76, 100–101, 125–133, 152–162, 209, 258–259, 279–290, 297–299
   vanity_address.py561082%41, 45–48, 112, 114, 121–123
   wallet.py79495%21, 66, 136, 162
src/algokit/core
   conf.py57984%12, 24, 28, 36, 38, 73–75, 80
   dispenser.py2022687%91, 123–124, 141–149, 191–192, 198–200, 218–219, 259–260, 318, 332–334, 345–346, 356, 369, 384
   doctor.py65789%67–69, 92–94, 134
   generate.py48394%44, 81, 99
   goal.py60395%30–31, 41
   init.py671085%53, 57–62, 70, 81, 88, 108–109
   log_handlers.py68790%50–51, 63, 112–116, 125
   proc.py45198%98
   sandbox.py2181892%62, 73–75, 96, 142–149, 160, 456, 472, 497, 505
   typed_client_generation.py1702088%62–64, 103–108, 132, 135–138, 156, 159–162, 229, 232–235
   utils.py1584671%51–52, 56–77, 134–140, 164, 167, 173–186, 207–209, 238–241, 263
   version_prompt.py921485%37–38, 68, 87–90, 108, 118–125, 148
src/algokit/core/compilers
   python.py28582%19–20, 25, 49–50
src/algokit/core/project
   __init__.py53394%50, 86, 145
   bootstrap.py120893%47, 126–127, 149, 176, 207–209
   deploy.py54983%61–64, 73–75, 79, 84
   run.py1251588%83, 88, 97–98, 133–134, 138–139, 143, 147, 261–269, 284
src/algokit/core/tasks
   analyze.py93397%105–112, 187
   ipfs.py63789%58–64, 140, 144, 146, 152
   nfd.py491373%25, 31, 34–41, 70–72, 99–101
   vanity_address.py903462%49–50, 54, 59–75, 92–108, 128–131
   wallet.py71593%37, 129, 155–157
src/algokit/core/tasks/mint
   mint.py781087%123–133, 187
   models.py901188%50, 52, 57, 71–74, 85–88
TOTAL428652588% 

Tests Skipped Failures Errors Time
482 0 💤 0 ❌ 0 🔥 31.644s ⏱️

@aorumbayev aorumbayev requested a review from neilcampbell April 25, 2024 11:55
docs/tutorials/intro.md Outdated Show resolved Hide resolved
docs/tutorials/intro.md Outdated Show resolved Hide resolved
docs/tutorials/intro.md Outdated Show resolved Hide resolved
docs/tutorials/intro.md Outdated Show resolved Hide resolved
docs/tutorials/intro.md Outdated Show resolved Hide resolved
docs/tutorials/intro.md Outdated Show resolved Hide resolved
docs/tutorials/intro.md Outdated Show resolved Hide resolved
docs/tutorials/intro.md Outdated Show resolved Hide resolved
docs/tutorials/intro.md Outdated Show resolved Hide resolved
docs/tutorials/intro.md Outdated Show resolved Hide resolved
docs/tutorials/intro.md Outdated Show resolved Hide resolved
@aorumbayev aorumbayev force-pushed the docs/refresh-tutorial branch from 6c35c48 to 8a104fe Compare May 13, 2024 14:25
@aorumbayev
Copy link
Collaborator Author

@Loedn I've added a detailed rewrite for the intro tutorial to assume latest python template and the workspace mode (see comments from @neilcampbell above that i've addressed). I've noticed that the videos in header redirect to outdated videos so i've added an explicit note to that section. If any further tweaks would be needed in the docs feel free to open up a new issue or tag us by reopening the existing one (#486).

@aorumbayev aorumbayev merged commit 1964dec into main May 13, 2024
14 checks passed
@aorumbayev aorumbayev deleted the docs/refresh-tutorial branch May 13, 2024 14:43
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