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.

Sign up for GitHub

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

Jump to bottom

Document each block with a README #14

Open
bobbingwide opened this issue Mar 7, 2018 · 1 comment
Open

Document each block with a README #14

bobbingwide opened this issue Mar 7, 2018 · 1 comment
Assignees
@bobbingwide
Labels
enhancement New feature or request

Comments

@bobbingwide
Copy link
Owner

Each block that we create should be documented with a README file

Requirements

To consist of some or all of the following sections

  • Overview
  • Browser view
  • Editor view
  • Additional settings view
  • Requirements
  • Future requirements
  • Scope and exclusions
  • Issue summary
  • links for further information

Proposed solution

  • The built version of the plugin does not need to contain this information
@bobbingwide bobbingwide self-assigned this Mar 7, 2018
bobbingwide referenced this issue in bobbingwide/oik-block Apr 8, 2018
@bobbingwide
Issue #14 - start fleshing out the build process
2b20b69
@bobbingwide bobbingwide transferred this issue from bobbingwide/oik-block Nov 23, 2018
@bobbingwide bobbingwide added the enhancement New feature or request label Jan 14, 2022
@bobbingwide
Copy link
Owner Author

Well, it was a nice idea. But I never got around to it within the source code. Each block I've developed has:

  1. At least one issue somewhere on GitHub.
  2. Documentation on one or more of the following sites: oik-plugins.com, blocks.wp-a2z.org, herbmiller.me, sneak-peek.me
  3. Examples on the above sites.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bobbingwide bobbingwide

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@bobbingwide