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

FFIG could use a developers guide #407

Open
Twon opened this issue Apr 17, 2018 · 3 comments
Open

FFIG could use a developers guide #407

Twon opened this issue Apr 17, 2018 · 3 comments
Assignees

Comments

@Twon
Copy link
Collaborator

Twon commented Apr 17, 2018

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

@Twon Twon self-assigned this Apr 17, 2018
@jbcoe
Copy link
Collaborator

jbcoe commented Apr 17, 2018

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?

@Twon
Copy link
Collaborator Author

Twon commented Apr 17, 2018

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.

@jbcoe
Copy link
Collaborator

jbcoe commented Apr 17, 2018

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants