Giters

alan-if / alan-docs

Alan IF Documentation Project

Home Page:https://git.io/alan-docs

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Wiki Page on Dynamic Examples and Transcripts

tajmone opened this issue · comments

commented

Add Wiki page on Dynamic Examples and Transcripts (see AnssiR66/AlanStdLib#82) which will then become the reference documentation on how to implement this feature in any ALAN-related docs that want to automate the generation of code examples and their transcripts, to ensure that they'll always match real use cases with the latest ALAN SDK.

  • Create new Wiki a page "Dynamic Examples and Transcripts"
  • Add a link to the newly created page in:
    • CONTRIBUTING.md.
    • in the README of the documents in this repo that are using this approach:
      • Beginner's Guide
    • READMEs of StdLib repository.
commented

Wiki Page Created

Although still incomplete, I've started writing the article on Dynamic Examples:

https://github.com/alan-if/alan-docs/wiki/Dynamic-Examples

It will eventually be completed (although it will still be updated in the future, especially regarding its usage in Rake), but we can being referencing and linking it in the various READMEs of ALAN projects.