Accord Project: Google Season of Docs Ideas List

Below are a list of project ideas organized by the copy and generation of copy for Accord Project documentation.

We also welcome applicants' input on those projects or alternative project proposals in the different areas listed below and in scope with the goals of the Accord Project.

Documentation Copy

Refactor Existing Documentation

Description: Refactor the open source project’s existing documentation to provide an improved user experience or a more accessible information architecture.

Related Material: Current documentation

Mentor: Dan Selman

Documentation with Playground

Description: Add a sort of “Try it!” button in the documentation where you could run: CiceroMark templates and Ergo statements and see the output. This should investigate the use of Docusaurus 2 with plugins which it seems would provide a nice way to support this kind of functionality.

Related Material: Our Issue around an Ergo REPL and HandlebarsJS

Mentor: Jerome Simeon

Documentation Generation

API and JSDoc Generation

Description: The API sections in the “Reference” part of the documentation is automatically generated from JSDoc. It is not consistently maintained, and the build process is a bit clumsy. The goal of the project would be to: review the current user API (what is public or not), get all the JSDoc up to date and revise the way we build and publish the documentation from JSDoc.

Related Material: JSDoc

Mentor: Dan Selman

ErgoDoc Automation

Description: Automated documentation for template, improved template library pages.

Related Material: Current Template Library and our open Issue on ErgoDoc

Mentor: Jerome Simeon