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 Interactive Code Block #61

Open
5 tasks
adamziel opened this issue Jun 2, 2023 · 0 comments
Open
5 tasks

Document Interactive Code Block #61

adamziel opened this issue Jun 2, 2023 · 0 comments
Labels
Documentation Improvements or additions to documentation Enhancement New feature or request interactive code block

Comments

@adamziel
Copy link
Collaborator

adamziel commented Jun 2, 2023

Building the Interactive Code Block with nx build interactive-code-block outputs a .zip bundle in dist/packages that can be installed as a WordPress plugin. This issue is mean to document:

  • What the block is about
  • How to build it
  • How to install it
  • How to use it
  • How and what to contribute
@adamziel adamziel added Documentation Improvements or additions to documentation Enhancement New feature or request interactive code block labels Jun 2, 2023
This was referenced Jun 2, 2023
Closed
Open
johnhooks pushed a commit to johnhooks/playground-tools that referenced this issue Oct 11, 2024
@adamziel
Migrate the project to TypeScript (WordPress#61)
77d9047 
The major reason is that JavaScript documentation tools are severely
lacking and they don't even support the modern JavaScript syntax.
TypeScript is well supported, and the official tsdoc project provides
tools to generate the api model from the codebase. From there,
generating a markdown reference is just a templating problem.

Documentatino aside, this brings the type safety, enables static checks,
and gives us autocompletion for free.
johnhooks pushed a commit to johnhooks/playground-tools that referenced this issue Oct 11, 2024
@adamziel
Add cohesive developer documentation in /docs (WordPress#67)
a2563cd 
This PR populates /docs with a step-by-step documentation connecting the priors documentation efforts shipped in:

* API Reference documentation WordPress#63
* Migrate the project to TypeScript WordPress#61
* Add developer documentation  WordPress#60
* Monorepo WordPress#57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Improvements or additions to documentation Enhancement New feature or request interactive code block
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@adamziel