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 revamp: new top toolbar build #478

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

rube-de
Copy link
Contributor

@rube-de rube-de commented Dec 27, 2024

  • split sapphire guide chapter and create new group
  • refactor to build top folder

dependency to oasisprotocol/docs#1058

@rube-de rube-de linked an issue Dec 27, 2024 that may be closed by this pull request
Copy link

netlify bot commented Dec 27, 2024

Deploy Preview for oasisprotocol-sapphire-paratime failed.

Name Link
🔨 Latest commit 976def4
🔍 Latest deploy log https://app.netlify.com/sites/oasisprotocol-sapphire-paratime/deploys/677f64cd99812e00080eff8a

@rube-de rube-de force-pushed the rube/461-docs-revamp-sapphire---guide-chapter branch from 20df060 to 9994890 Compare December 27, 2024 18:05
@rube-de rube-de changed the title docs revamp sapphire guide chapter docs revamp: new top toolbar build Jan 2, 2025
@rube-de
Copy link
Contributor Author

rube-de commented Jan 2, 2025

also includes oasisprotocol/docs#1036

@rube-de rube-de force-pushed the rube/461-docs-revamp-sapphire---guide-chapter branch from 2146cfa to 295507b Compare January 6, 2025 12:37
@rube-de rube-de marked this pull request as ready for review January 6, 2025 12:50
@rube-de rube-de requested review from matevz and aefhm January 6, 2025 12:50
Copy link
Member

@matevz matevz left a 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.

@rube-de
Copy link
Contributor Author

rube-de commented Jan 7, 2025

I'm uncertain about having duplicate /build/sapphire/build paths. Perhaps develop to avoid duplicate entries or something completely different (topics, features, guide?).

yes could be develop

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?

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 thinks we should have all features and integrations in one place. Means we should write all READMEs in the repos as docs compatible that they can be linked.

@aefhm
Copy link
Contributor

aefhm commented Jan 8, 2025

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?

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 thinks we should have all features and integrations in one place. Means we should write all READMEs in the repos as docs compatible that they can be linked.

I'm a fan of READMEs.

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?

Is the goal to basically on-board devs to use that specific tool on Sapphire?

@matevz
Copy link
Member

matevz commented Jan 8, 2025

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).

@rube-de
Copy link
Contributor Author

rube-de commented Jan 9, 2025

I'm fine with moving the hardhat to tools, even though I think it is very sapphire specific. (see below)
Maybe lets have again a brainstorm session to agree on future structure, also in foresight of v2 js client.

@rube-de rube-de force-pushed the rube/461-docs-revamp-sapphire---guide-chapter branch from 295507b to 976def4 Compare January 9, 2025 05:55
@rube-de
Copy link
Contributor Author

rube-de commented Jan 9, 2025

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.

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.
Like pages "encrypted transactions" and explain how to use a sapphire providers or "write tests".

So I would remove the hardhat/foundry pages and move some hardhat parts in a testing page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Revamp Sapphire -> Guide chapter
3 participants