chore: add README and import script #261
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
to match readme
|
jcstein
changed the title
and then run yarn import-readme after rollkit source is updated
|
Does this render updates automatically? If so, do we have any concerns with it targeting main vs a release? If it targets a release, we could look into setting a trigger to auto update this like the other versions in the docs. |
|
the script can currently be ran manually. the current idea would be to run this after a release of rollkit, and make a PR with the edited file. just run however, i think targeting a release, turning this into a github action instead of just a script, and implementing latest tags workflow in vitepress is better in the long run |
|
are you alright with merging this and in a following PR completing:
opened #263 to track these |
jcstein
changed the title
jcstein
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Resolves #193
This removes the building-with-rollkit page and uses the README from rollkit/rollkit using an
importReadme.mjsscript.This is so that we can import with a script similarly to the way that this script pulls in Blobstream (fka QGB) docs in.
This PR is to be updated and merged after this 1247 on rollkit
Preview of page in this PR
Checklist