-
Notifications
You must be signed in to change notification settings - Fork 31
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
Restructure docs #200
Restructure docs #200
Conversation
✅ Deploy Preview for trusting-archimedes-14c863 ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
Nice! Probably "Oasis Core" should go under "Developers" instead of being its own tab? |
a4dc867
to
ca53e1b
Compare
b709c8f
to
f95a5ab
Compare
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.
On the Developers -> Oasis SDK page it seems that the "Oasis Core Runtime Layer" link points to GitHub.
I was thinking of solving those in a separate PR #203. |
f95a5ab
to
e6df70e
Compare
Now implemented as part of this PR. |
b13c226
to
04b6f27
Compare
Because restructuring the docs is a big deal we should not rush it. In general I like the new structure, but I still have a few suggestions.
|
On the other hand this seems weird as the Contract SDK documentation is general for any paratime using the |
In case we want to make this Cipher-specific we should probably move these contract docs outside the SDK repository? But then we are left without general contract SDK docs not specific to any paratime deployment? |
Agree that the SDK docs should probably be separate, especially if we move out the "Cipher ParaTime" docs? So the SDK contains a bunch of things (as mentioned in the docs):
Note that all of these are general and unrelated to any specific runtime/paratime deployment. But saying "Core Developers" and "Contract Developers" is way too long. In my mind the categories are something like:
So maybe we should move the general WASM contracts section (and related API reference links) out under Contracts -> Cipher if this is possible to do. |
Also one thing that is strange is the "Network Primer" (the "Why Oasis" and "ROSE Token Metrics" links lead there) as it seems like it is a completely separate thing instead of being a section in the main docs. I think it should be merged into the main docs now that we have reduced clutter there. |
Yeah this is probably right. Same with the delegation policy. |
Makes sense. Initially it has been bugging me that we promote ParaTimes, but then the docs aren't organized around them. But I am beginning to think that it makes a lot of sense to keep node operator and all developer docs paratime-agnostic and focused on the technological/functional aspects. Lets imagine the following user story: I heard about the confidentiality features (replace with any other feature) of Sapphire (replace with other ParaTime). As a developer I want to develop a smart contract on Sapphire. Where do I start? Because we promote ParaTimes, the solution would be if each ParaTime has a dedicated category under "General". It should clearly describe what it is (from contribute-to-the-network/run-a-paratime-node) and which technologies are being used with links to relevant developer docs. |
8d470d9
to
2aff189
Compare
The mainnet and testnet categories are now moved under |
Looks like the "Network Parameters" are still in the General sidebar and clicking on it switches to the Node Operators tab. |
FYI this is deliberate so you can access current network parameters with a single click. |
Why would someone that is not a node operator need to access network parameters? |
- also moved delegation-policy.md to contribute-to-the-network/ - moved network-paramters.md to operators/mainnet
…perators/set-up-your-node - replace generic {prerequisites|maintenance-guides|advanced}/README.md files with generated-index - move operators/troubleshooting.md to operators/set-up-your-node
- Also rename how-to-transfer-rose-into-evm-paratime -> how-to-transfer-rose-into-paratime
- removes docs/general/manage-tokens/holding-rose-tokens/README.md in favor of autogenerated-index
0b9b14b
to
0fc2045
Compare
7f5887f
to
dc9708f
Compare
dc9708f
to
62f386b
Compare
62f386b
to
e99e238
Compare
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.
Thanks again, @matevz!
Fixes #184, #125, #203, #10.
New features:
Edit page
link across all components and repositories,Structural changes:
general
,get-involved
,node
,dapp
,paratime
, andcore
. Now the chapters are not repository-based anymore (e.g. docs of oasis-sdk git module now became some sections ofdapp
chapter).plugin-content-docs
plugins by unifying the site structure and takingdocs/
as a site rootgeneral
tonode
and Prerequisites, Maintenance, Advanced sections torun-your-node
categorygenesis-doc.md
fromgeneral/manage-tokens
tonode
dapp
with Emerald and Sapphire tutorials and oasis-sdk/docs/contract for Cipher sectionparatime
chapter containing oasis-sdk/docs/runtime filesindex.md
,overview.md
,getting-started.md
files toREADME.md
. Always open it directly when clicking on the category link. Use generated table of contents withgenerated-index
doc page type, if no feasible information exists.token-delivery-and-kyc
toget-involved
chapter and the remaininggeneral/community-resources
toget-involved
.