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: refactor package & realm concept pages #1469

Open
wants to merge 45 commits into
base: master
Choose a base branch
from

Conversation

leohhhn
Copy link
Contributor

@leohhhn leohhhn commented Dec 19, 2023

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...
  • Added new tests, or not needed, or not feasible
  • Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
  • Updated the official documentation or not needed
  • No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
  • Added references to related issues and PRs
  • Provided any useful hints for running manual tests
  • Added new benchmarks to generated graphs, if any. More info here.

@leohhhn leohhhn added the 📖 documentation Improvements or additions to documentation label Dec 20, 2023
@leohhhn leohhhn changed the title docs: modify package & realm concept pages docs: clarify pkgpaths, modify package & realm concept pages Jan 17, 2024
@github-actions github-actions bot removed the 📖 documentation Improvements or additions to documentation label Jan 24, 2024
@leohhhn leohhhn changed the title docs: clarify pkgpaths, modify package & realm concept pages docs: refactor package & realm concept pages Mar 26, 2024
Copy link

codecov bot commented Apr 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 60.44%. Comparing base (dd2d374) to head (ee62df0).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1469      +/-   ##
==========================================
- Coverage   60.44%   60.44%   -0.01%     
==========================================
  Files         563      563              
  Lines       75159    75159              
==========================================
- Hits        45431    45430       -1     
- Misses      26341    26342       +1     
  Partials     3387     3387              
Flag Coverage Δ
contribs/gnodev 61.46% <ø> (ø)
contribs/gnofaucet 14.46% <ø> (ø)
gno.land 67.21% <ø> (ø)
gnovm 64.46% <ø> (ø)
misc/genstd 80.54% <ø> (ø)
misc/logos 19.88% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Let's look at return values for each of the methods:
```go
std.GetOrigCaller() => `g1jg8mtutu9khhfwc4nxmuhcpftf0pajdhfvsqf5`
std.PrevRealm() => `g1jg8mtutu9khhfwc4nxmuhcpftf0pajdhfvsqf5`
Copy link
Member

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?

Copy link
Contributor Author

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 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed: 674e80c

@moul
Copy link
Member

moul commented Apr 8, 2024

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.

misc/docusaurus/sidebars.js Outdated Show resolved Hide resolved
leohhhn and others added 2 commits June 5, 2024 13:17
# Conflicts:
#	docs/concepts/stdlibs/coin.md
#	docs/reference/stdlibs/std/chain.md
#	docs/reference/stdlibs/std/realm.md
#	misc/docusaurus/sidebars.js
@leohhhn leohhhn mentioned this pull request Jun 26, 2024
[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
Copy link
Contributor

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.

@leohhhn
Copy link
Contributor Author

leohhhn commented Aug 27, 2024

Awaiting reviews on this to merge it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧾 package/realm Tag used for new Realms or Packages.
Projects
Status: Awaiting/Blocked
Status: In Progress
Status: No status
Status: In Review
Development

Successfully merging this pull request may close these issues.

Realms as EOAs
4 participants