-
Notifications
You must be signed in to change notification settings - Fork 34
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
Conversation
✅ Deploy Preview for trusting-archimedes-14c863 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
6782af5
to
ca0f374
Compare
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). |
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.
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)
803a77e
to
f780058
Compare
f780058
to
dbcdb15
Compare
dbcdb15
to
e44ee08
Compare
This PR:
Merge after oasisprotocol/sapphire-paratime#227 is merged in.
Preview