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: Migrate Sapphire docs to sapphire-paratime repo #636

Merged
merged 2 commits into from
Nov 27, 2023

Conversation

matevz
Copy link
Member

@matevz matevz commented Nov 24, 2023

This PR:

  • adds oasisprotocol/sapphire-paratime git module.
  • migrates Sapphire docs from this repo to sapphire-paratime including Sapphire-related images and diagrams.
  • updates remark plugins for URL transformations.

Merge after oasisprotocol/sapphire-paratime#227 is merged in.

Preview

Copy link

netlify bot commented Nov 24, 2023

Deploy Preview for trusting-archimedes-14c863 ready!

Name Link
🔨 Latest commit e44ee08
🔍 Latest deploy log https://app.netlify.com/sites/trusting-archimedes-14c863/deploys/6564aa40c815a60008f1fab8
😎 Deploy Preview https://deploy-preview-636--trusting-archimedes-14c863.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@matevz matevz force-pushed the matevz/docs/migrate-sapphire-docs branch 2 times, most recently from 6782af5 to ca0f374 Compare November 24, 2023 16:33
@matevz matevz requested a review from CedarMist November 24, 2023 16:35
@CedarMist
Copy link
Member

Out of curiosity, why are the individual .md files symlinked, instead of the sapphire/docs directory being symlinked?

@matevz
Copy link
Member Author

matevz commented Nov 24, 2023

Out of curiosity, why are the individual .md files symlinked, instead of the sapphire/docs directory being symlinked?

I thought keeping README.mdx inside the docs repo might be a good idea, because it contains stuff like endpoint URLs and Metamask network installation snippets.

So this prevents you from linking the whole directory, because you cannot inject individual files in then.

btw. We use the same approach in Cipher. To update docs.oasis.io with the new version of the docs inside the external repo you need to bump the commit to external repo (we use dependabot for this—you just need to approve the PR). If you add a new file, you also need to add a new symlink inside the docs folder then (and add redirection, if you removed anything).

Copy link
Member

@CedarMist CedarMist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok this seems fine, dependabot will submit PR on new Sapphire releases (but not releases of contracts or clients) and we can just remember to periodically update the submodule and add/remove individual .md files as necessary (less ideal, but it works for now)

@matevz matevz force-pushed the matevz/docs/migrate-sapphire-docs branch 3 times, most recently from 803a77e to f780058 Compare November 27, 2023 14:34
@matevz matevz force-pushed the matevz/docs/migrate-sapphire-docs branch from f780058 to dbcdb15 Compare November 27, 2023 14:35
@matevz matevz force-pushed the matevz/docs/migrate-sapphire-docs branch from dbcdb15 to e44ee08 Compare November 27, 2023 14:39
@matevz matevz merged commit dba6ae3 into main Nov 27, 2023
6 checks passed
@matevz matevz deleted the matevz/docs/migrate-sapphire-docs branch November 27, 2023 14:45
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.

2 participants