-
Notifications
You must be signed in to change notification settings - Fork 29
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 revamp: new top toolbar build #478
base: main
Are you sure you want to change the base?
Conversation
❌ Deploy Preview for oasisprotocol-sapphire-paratime failed.
|
20df060
to
9994890
Compare
also includes oasisprotocol/docs#1036 |
2146cfa
to
295507b
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.
I'm uncertain about having duplicate /build/sapphire/build
paths. Perhaps /build/sapphire/develop
to avoid duplicate entries or something completely different (topics
, features
, guide
?).
I'm also hesitant about having Hardhat and Foundry chapters since these are tools rather than Sapphire-specific topics (similar to Remix, Sourcify). Granted, we offer Sapphire-specific wrappers, but then does this mean we should also be having ethers, viem and wagmi chapters? For now I would try to avoid having technology-oriented chapters inside the Sapphire section, but have more task/functionality oriented ones. We can always put integration- and client-specific notes inside their corresponding README file in the corresponding repo for interested audience. So, to summarize, I would have "How can I have anonymous ERC20 token?", "How do I build a DEX?", "How can I make user not pay gas fees?", "How can make a mobile+web dApp?", "How do I upgrade contract?" and other "How do I..." chapters which are all task-oriented, but explain the underlying tech and tools along the way.
yes could be develop
yes, we had talked about linking the the READMEs of ethers wagmi, viem another time. Ahmed, also suggested to have it in the docs. |
I'm a fan of READMEs.
Is the goal to basically on-board devs to use that specific tool on Sapphire? |
Yes, ideally we should suggest one modern and popular stack that works best in the Quickstart chapter. In parallel, we maintain compatibility and document how to use alternative tools with Sapphire (build toolkits, UI libs, programming languages). |
|
295507b
to
976def4
Compare
I don't know if I missed it or I had still the before edit cached. I totally agree on having tasks oriented pages vs technology. So I would remove the hardhat/foundry pages and move some hardhat parts in a testing page. |
dependency to oasisprotocol/docs#1058