docs: refine quick start (#487)

* docs: refine quick start * chore: patching ci * docs: removing redundant images * chore: testing ci * chore: patch video ref * chore: patch video ref * chore: pr comments * chore: apply suggestions from code review Co-authored-by: Neil Campbell <[email protected]> * docs: refine docs * docs: use workspace mode by default, add extra comments on workspace mode structure * chore: fixing pip audit warning * chore: pip audit warning * docs: add note on videos in header --------- Co-authored-by: Neil Campbell <[email protected]>
algorandfoundation · May 13, 2024 · 1964dec · 1964dec · github-actions · May 13, 2024
1 parent 70c55e0
commit 1964dec
Show file tree

Hide file tree

Showing 14 changed files with 83 additions and 81 deletions.
diff --git a/.github/workflows/build-binaries.yaml b/.github/workflows/build-binaries.yaml
@@ -15,8 +15,10 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        # macos-14 is the Apple Silicon M1 runner
-        os: [ubuntu-20.04, windows-latest, macos-latest, macos-14]
+        # macos-14 is the Apple Silicon M1 runner (mac os 14)
+        # macos-13 is the last available Intel Mac runner (mac os 13)
+        # See https://github.com/actions/runner-images?tab=readme-ov-file#available-images
+        os: [ubuntu-20.04, windows-latest, macos-13, macos-14]
 
     steps:
       - name: Checkout source code

diff --git a/docs/imgs/algokitcodetour.png b/docs/imgs/algokitcodetour.png
diff --git a/docs/imgs/algokitdemo.png b/docs/imgs/algokitdemo.png
diff --git a/docs/imgs/algokitplayground.png b/docs/imgs/algokitplayground.png
diff --git a/docs/imgs/dappflow.png b/docs/imgs/dappflow.png
diff --git a/docs/imgs/dappflow1.png b/docs/imgs/dappflow1.png
diff --git a/docs/imgs/dappflow2.png b/docs/imgs/dappflow2.png
diff --git a/docs/imgs/dappflow3.png b/docs/imgs/dappflow3.png
diff --git a/docs/imgs/dappflow4.png b/docs/imgs/dappflow4.png
diff --git a/docs/imgs/dappflow5.png b/docs/imgs/dappflow5.png
diff --git a/docs/imgs/dappflow6.png b/docs/imgs/dappflow6.png
diff --git a/docs/imgs/dappflow_transaction.png b/docs/imgs/dappflow_transaction.png
diff --git a/docs/tutorials/intro.md b/docs/tutorials/intro.md
diff --git a/poetry.lock b/poetry.lock
File	Stmts	Miss	Cover	Missing
src/algokit
__init__.py	15	7	53%	6–13, 17–24, 32–34
__main__.py	4	4	0%	1–7
src/algokit/cli
__init__.py	47	3	94%	31–34
completions.py	108	9	92%	63–64, 83, 93–99
dispenser.py	121	1	99%	77
doctor.py	49	3	94%	143–145
explore.py	50	12	76%	34–39, 41–46
generate.py	70	3	96%	76–77, 155
goal.py	44	1	98%	71
init.py	309	24	92%	493–494, 499–500, 503, 524, 527–529, 540, 544, 602, 628, 657, 690, 699–701, 704–709, 722, 741, 753–754
localnet.py	119	15	87%	74–78, 111, 123, 138–148, 161, 206, 227–228
task.py	34	3	91%	25–28
src/algokit/cli/common
utils.py	26	2	92%	120, 123
src/algokit/cli/project
bootstrap.py	32	1	97%	33
deploy.py	99	20	80%	47, 49, 101, 124, 146–148, 227, 234, 248–256, 259–268
link.py	89	16	82%	60, 65–66, 101–105, 115–120, 148–149, 218–219, 223
list.py	33	5	85%	21–23, 51–56
run.py	46	3	93%	38, 71, 160
src/algokit/cli/tasks
analyze.py	81	1	99%	81
assets.py	82	13	84%	65–66, 72, 74–75, 105, 119, 125–126, 132, 134, 136–137
ipfs.py	51	8	84%	52, 80, 92, 94–95, 105–107
mint.py	66	4	94%	48, 70, 91, 250
send_transaction.py	65	10	85%	52–53, 57, 89, 158, 170–174
sign_transaction.py	59	8	86%	21, 28–30, 71–72, 109, 123
transfer.py	39	3	92%	26, 90, 117
utils.py	99	45	55%	26–34, 40–43, 75–76, 100–101, 125–133, 152–162, 209, 258–259, 279–290, 297–299
vanity_address.py	56	10	82%	41, 45–48, 112, 114, 121–123
wallet.py	79	4	95%	21, 66, 136, 162
src/algokit/core
conf.py	57	9	84%	12, 24, 28, 36, 38, 73–75, 80
dispenser.py	202	26	87%	91, 123–124, 141–149, 191–192, 198–200, 218–219, 259–260, 318, 332–334, 345–346, 356, 369, 384
doctor.py	65	7	89%	67–69, 92–94, 134
generate.py	48	3	94%	44, 81, 99
goal.py	60	3	95%	30–31, 41
init.py	67	10	85%	53, 57–62, 70, 81, 88, 108–109
log_handlers.py	68	7	90%	50–51, 63, 112–116, 125
proc.py	45	1	98%	98
sandbox.py	218	18	92%	62, 73–75, 96, 142–149, 160, 456, 472, 497, 505
typed_client_generation.py	170	20	88%	62–64, 103–108, 132, 135–138, 156, 159–162, 229, 232–235
utils.py	158	46	71%	51–52, 56–77, 134–140, 164, 167, 173–186, 207–209, 238–241, 263
version_prompt.py	92	14	85%	37–38, 68, 87–90, 108, 118–125, 148
src/algokit/core/compilers
python.py	28	5	82%	19–20, 25, 49–50
src/algokit/core/project
__init__.py	53	3	94%	50, 86, 145
bootstrap.py	120	8	93%	47, 126–127, 149, 176, 207–209
deploy.py	54	9	83%	61–64, 73–75, 79, 84
run.py	125	15	88%	83, 88, 97–98, 133–134, 138–139, 143, 147, 261–269, 284
src/algokit/core/tasks
analyze.py	93	3	97%	105–112, 187
ipfs.py	63	7	89%	58–64, 140, 144, 146, 152
nfd.py	49	13	73%	25, 31, 34–41, 70–72, 99–101
vanity_address.py	90	34	62%	49–50, 54, 59–75, 92–108, 128–131
wallet.py	71	5	93%	37, 129, 155–157
src/algokit/core/tasks/mint
mint.py	78	10	87%	123–133, 187
models.py	90	11	88%	50, 52, 57, 71–74, 85–88
TOTAL	4286	525	88%