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

V6 Docs #496

Merged
merged 22 commits into from
Apr 30, 2018
Merged

V6 Docs #496

merged 22 commits into from
Apr 30, 2018

Conversation

MarshallOfSound
Copy link
Member

@MarshallOfSound MarshallOfSound commented Apr 28, 2018

  • I have read the contribution documentation for this project.
  • I agree to follow the code of conduct that this project follows, as appropriate.
  • The changes are appropriately documented (if applicable).
  • The changes have sufficient test coverage (if applicable).
  • The testsuite passes successfully on my local machine (if applicable).

WIP site can be viewed at: https://v6.electronforge.io/

TODO:

  • Landing
  • Introduction (README)
  • Configuration (just packager / rebuild configs and general tricks for setting config like env vars and such)
  • CLI
  • API Docs (auto-generated)
  • Plugins (probably won't finish in this PR, the plugins aren't technically read yet)
  • Makers
  • Publishers
  • Debugging (the stuff that used to be at the bottom of the readme)
  • Extending Forge
  • Add doc comments for the PublisherOptions interface
  • Add doc comments for the MakerOptions interface

@MarshallOfSound
Copy link
Member Author

I know the commits look super weird on this PR, but we'll just squash and merge and it'll all be fine 😆

@MarshallOfSound MarshallOfSound changed the title Docs [WIP] V6 Docs Apr 28, 2018
@MarshallOfSound
Copy link
Member Author

Current plan is to put a giant "THIS IS A WORK IN PROGRESS / BETA" banner on the top of the plugins docs page, just to give us time to play with / make work properly 😄

@MarshallOfSound MarshallOfSound changed the title [WIP] V6 Docs V6 Docs Apr 30, 2018
@MarshallOfSound
Copy link
Member Author

Only thing pending is filling out the landing page of https://v6.electronforge.io/ with some info or something 🤔

Probably just general overview of forge / project goals / link to Getting Started. Can deal with that after this is merged

@MarshallOfSound MarshallOfSound merged commit dab06d9 into master Apr 30, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant