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

[WIP] Docify Integration #145

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

[WIP] Docify Integration #145

wants to merge 4 commits into from

Conversation

CrackTheCode016
Copy link
Contributor

@CrackTheCode016 CrackTheCode016 commented Oct 5, 2023

This PR adds a program that uses docify to selectively add snippets to markdown files. These snippets can be fixed at a certain hash per repo. This is most likely to be run as a CI tool at some point every so often, or simply manually run once there is a new release of polkadot-sdk

See issue #143

  1. Parses the file path and file name from any .md files.
  2. Downloads those snippets and emulates the correct directories for all docify needs
  3. Docify's compile_markdown! is run on all affected files, and derives snippets from each downloaded file
  4. Emulated directories are deleted and cleaned up

This script is a bit rough, but is getting the job done so far ;)

@CrackTheCode016 CrackTheCode016 added the A1 - In Progress Pull Request needs to be updated. label Oct 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A1 - In Progress Pull Request needs to be updated.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant