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.

Sign up for GitHub

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

Jump to bottom

docs: namespaces concepts page #1909

Merged
merged 6 commits into from
Apr 16, 2024
Merged

docs: namespaces concepts page #1909

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f42dd7a
docs: init concepts/namespaces
harry-hov Apr 9, 2024
6bc31ce
Update namespaces.md
harry-hov Apr 10, 2024
2464e21
Update
harry-hov Apr 10, 2024
4707743
Fix review comments
harry-hov Apr 16, 2024
8795886
Explain path part constrains clearly
harry-hov Apr 16, 2024
dffb722
Fix review comments
harry-hov Apr 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions docs/concepts/namespaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
id: namespaces
---

# Namespaces

Namespaces provide users with the capability to publish contracts under their designated namespaces, similar to GitHub's user and organization model.
harry-hov marked this conversation as resolved.
Show resolved Hide resolved

This feature is currently a work in progress (WIP). To learn more about namespaces, please checkout https://github.com/gnolang/gno/issues/1107.

# Package Path
harry-hov marked this conversation as resolved.
Show resolved Hide resolved

A package path is a unique identifier for each package/realm. It specifies the location of the package source code which helps differentiate it from others. You can use a package path to:

- Call a specific function from a package/realm. (e.g using `gnokey maketx call`)
- Import it in other packages/realms.

Here's a breakdown of the structure of a package path:

- Domain: The domain of the blockchain where the package is deployed. Currently, only `gno.land/` is supported.
- Type: Defines the type of package.
- `p/`: [Package](packages.md)
- `r/`: [Realm](realms.md)
- Namespace: A namespace can be included after the type (e.g., user or organization name). Namespaces are a way to group related packages or realms, but currently ownership cannot be claimed. (see [Issue #1107](https://github.com/gnolang/gno/issues/1107) for more info)
- Remaining Path: The remaining part of the path.
- Can only contain alphanumeric characters (letters and numbers) and underscores.
- No special characters allowed (except underscore).
- Cannot consist solely of underscores. It must have at least one allowed alphanumeric character.
- Cannot start with a number. It should begin with a letter.
leohhhn marked this conversation as resolved.
Show resolved Hide resolved
- Cannot end with a trailing slash (`/`).

Examples:

- `gno.land/p/demo/avl`: This signifies a package named `avl` within the `demo` namespace.
- `gno.land/r/demo/users`: This signifies a realm named `users` within the `demo` namespace.
harry-hov marked this conversation as resolved.
Show resolved Hide resolved
1 change: 1 addition & 0 deletions misc/docusaurus/sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ const sidebars = {
items: [
'concepts/realms',
'concepts/packages',
'concepts/namespaces',
{
type: 'category',
label: 'Standard Libraries',
Expand Down
Loading