Skip to content

Docs/starlight docs#70

Merged
mrcointreau merged 21 commits into
mainfrom
docs/starlight-docs
May 20, 2026
Merged

Docs/starlight docs#70
mrcointreau merged 21 commits into
mainfrom
docs/starlight-docs

Conversation

@mrcointreau
Copy link
Copy Markdown
Contributor

Same of #61 + base branch main instead of refactor/util-v5

@mrcointreau mrcointreau mentioned this pull request May 8, 2026
@mrcointreau mrcointreau marked this pull request as ready for review May 11, 2026 09:09
Comment thread docs/src/content/docs/guide/transactions.md
cache: pip

- name: Install hatch
run: pip install hatch
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Were we using hatch before?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, hatch has been our build/dev tool since the initial commit. It's the build backend in pyproject.toml (hatchling) and defines all our envs (default, lint, test, docs, examples). Both ci.yaml and cd.yaml already pip install hatch and run hatch run ... the same way

Comment thread docs/scripts/generate-examples-mdx.ts Outdated
fs.writeFileSync(path.join(outputDir, `${example.slug}.mdx`), renderExamplePage(example))
}

process.stdout.write(`Generated ${examples.length} example page(s) in ${outputDir}\n`)
Copy link
Copy Markdown
Member

@iglosiggio iglosiggio May 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why? I would prefer console.log instead

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed in c251ab6

Copy link
Copy Markdown
Member

@iglosiggio iglosiggio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes feel ok. I think loosing doctests is not a good idea. Can we do something to get them back?

}
}

process.stdout.write('Generated legacy redirect shims\n')
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed in c628fab


```{testsetup}
```python
import algopy
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a way for this to be tested? I think doctests are a good idea to avoid docs desync-ing from reality.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed in d749ea4

D -->|compiled using| C
D -->|tested via| B
```
![Txn value generator diagram](/algorand-python-testing/images/txn-value-generator.svg)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please keep the sources for this diagram somewhere.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed in e01a5e3

@mrcointreau mrcointreau requested a review from iglosiggio May 14, 2026 12:36
Copy link
Copy Markdown
Member

@iglosiggio iglosiggio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM :)

contract = Counter()
result = contract.increment()
assert result.native == 1
assert result.as_uint64() == 1
Copy link
Copy Markdown
Member

@iglosiggio iglosiggio May 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

heh, was this a bug on our docs?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd not say a bug but .native is deprecated on the numeric arc4 types (UIntN and BigUIntN)

@mrcointreau mrcointreau merged commit f3a03d8 into main May 20, 2026
3 checks passed
@mrcointreau mrcointreau deleted the docs/starlight-docs branch May 20, 2026 09:02
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.

4 participants