-
Notifications
You must be signed in to change notification settings - Fork 389
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: refactor package & realm concept pages #1469
Conversation
# Conflicts: # docs/concepts/realms.md
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
docs/concepts/realms.md
Outdated
Let's look at return values for each of the methods: | ||
```go | ||
std.GetOrigCaller() => `g1jg8mtutu9khhfwc4nxmuhcpftf0pajdhfvsqf5` | ||
std.PrevRealm() => `g1jg8mtutu9khhfwc4nxmuhcpftf0pajdhfvsqf5` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
isn't this helper returning a Realm struct?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch. It returns a realm. Will fix 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed: 674e80c
I suggest using "Realm Package" instead of just "Realm" for clarity. Using "Realm User" may not be necessary. There is a definitional challenge here. Let's discuss this in a review meeting. |
# Conflicts: # docs/concepts/stdlibs/coin.md # docs/reference/stdlibs/std/chain.md # docs/reference/stdlibs/std/realm.md # misc/docusaurus/sidebars.js
docs/concepts/packages.md
Outdated
[here](https://github.com/gnolang/gno/tree/master/examples/gno.land/p/demo/seqid). | ||
|
||
## Packages vs Standard Libraries | ||
Apart from packages, Gno, like Go, has standard libraries. To better |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is only one standard library, containing multiple packages, either in Go or Gno.
Awaiting reviews on this to merge it |
@leohhhn do you still want reviews on this or should we close it for docs v2? |
🛠 PR Checks Summary🔴 Changes to 'docs' folder must be reviewed/authored by at least one devrel and one tech-staff Manual Checks (for Reviewers):
Read More🤖 This bot helps streamline PR reviews by verifying automated checks and providing guidance for contributors and reviewers. ✅ Automated Checks (for Contributors):🟢 Maintainers must be able to edit this pull request (more info) ☑️ Contributor Actions:
☑️ Reviewer Actions:
📚 Resources:Debug
|
Closing this as it has been reviewed in docs-v2 and merged. Thanks @thehowl |
Description
This PR refactors the Package & Realm concept pages in the docs, and fixes code/comments along the way.
Realm page is based on this reply from @moul.
Latest docs preview on Loom: https://www.loom.com/share/6f4ccfd615e7478fa4e58f8e1b6a8162?sid=f816751b-4521-476b-91b4-01d47bf85f80
Closes: #1579
Contributors' checklist...
BREAKING CHANGE: xxx
message was included in the description