w3f / w3f-education

Technical Education at Web3 Foundation
Other
17 stars 19 forks source link

[WIP] Docify Integration #145

Open CrackTheCode016 opened 1 year ago

CrackTheCode016 commented 1 year ago

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.
    1. Downloads those snippets and emulates the correct directories for all docify needs
    2. Docify's compile_markdown! is run on all affected files, and derives snippets from each downloaded file
    3. Emulated directories are deleted and cleaned up

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