ffig
ffig copied to clipboard
FFIG
FFIG could use a developers guide
Feature Request
Add a developers guide
Summary
Good documentation makes a system easier to pick up for users. I proposed a developers guide to FFIG would be a useful starting point.
Requirements
This should tell users what FFIG is, how it works, how to use FFIG and how to extend FFIG.
Non-requirements
Additional information
This is an awesome idea. I'm far too deep into FFIG to know where to start writing this now.
Would you, @Twon, be willing to take a shot?
Absolutely. First commit is in and writing this is helping me to figure out:
- What FFIG currently does
- How it does it
- What I would like it to
- How we could improve it.
Branch code (.md) looks great.
High level documentation like this is pure gold and we need more of it. I’m really bad at doing it but am glad I left breadcrumbs enough in place for you to piece things together.