Skip to content

docs(wiki): add wiki sources pointing to the atomic-knowledge corpus #35

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

Merged
robrigo merged 1 commit into from
Aug 18, 2026
Merged

docs(wiki): add wiki sources pointing to the atomic-knowledge corpus #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 27 additions & 0 deletions docs/wiki/Home.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# AtomicAssets

AtomicAssets is an NFT standard for WAX and other Antelope chains. This repository holds its
smart contract.

## Documentation

The validated, source-cited documentation for this contract lives in
[atomic-knowledge](https://github.com/atomicassets/atomic-knowledge):

- [Contract reference](https://github.com/atomicassets/atomic-knowledge/tree/main/reference/atomicassets):
structure, actions, tables, serialization, custom types, data precedence, notifications,
backing tokens, and the v2 upgrade
- [Guides](https://github.com/atomicassets/atomic-knowledge/tree/main/guides): the asset
lifecycle, offers, notification integration, claim links, querying the API, and contract
testing

## Releases and migration

[CHANGELOG.md](https://github.com/atomicassets/atomicassets-contract/blob/main/CHANGELOG.md)
records each release. Its 2.0.0 entry carries the v1 to v2 upgrade notes.

## v1 history

The original v1 wiki remains readable on the archived
[pinknetworkx/atomicassets-contract](https://github.com/pinknetworkx/atomicassets-contract/wiki)
repository.
20 changes: 20 additions & 0 deletions docs/wiki/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Wiki sources

These pages are the source of truth for the GitHub wiki. They are kept in the main repo so
documentation changes are reviewed alongside code changes.

To publish to the GitHub wiki of the hosting repo (the wiki git repo exists once the wiki
has at least one page created through the UI):

```sh
git clone https://github.com/<owner>/atomicassets-contract.wiki.git /tmp/contract-wiki
cp docs/wiki/*.md /tmp/contract-wiki/ # README.md is harmless to include
cd /tmp/contract-wiki
git add -A && git commit -m "Sync wiki from docs/wiki" && git push
```

The copy step never deletes: when a page is removed from docs/wiki, `git rm` it in the wiki
clone during the same sync, or the wiki keeps serving the removed page.

Page links between the files use wiki-style page names (e.g. `[Home](Home)`), which resolve
on the GitHub wiki. When viewing these files inside the repo, append `.md` mentally.
Loading