Good documentation is at the cornerstone of driving adoption of software libraries!

To enhance the communication of LCAx, our objective is to upgrade the existing website by providing more detailed explanations and improved documentation on how to utilize LCAx effectively.

• Add Installation Instructions to Documentation
  The current documentation for the LCAx website lacks instructions on how to install it. We aim to include clear installation instructions to help users get started with LCAx.
• Update README on GitHub
  The README on GitHub needs to be updated. It serves as the main page for LCAx and should provide relevant and current information about the project.
• Describe Use-Cases for LCAx
  Why should you use LCAx and how should it be used? Is some of the question-answer pairs we should add to the website.
• Provide Documentation for Writing Custom LCAx Parser
  LCAx will rely on the community to support for various LCA software and LCAx should therefore provide extensive documentation on how to write custom parsers/converters.
• Doc-strings for LCAx Objects
  In order to improve the understandability of the fields and objects in the LCAx data structure, we have a goal of incorporating explanatory doc-strings that offer insight into the reasoning behind them.
• Add JSON Schema Viewer on LCAx's Website
  A JSON Schema in its raw form is not easy to comprehend. We would like to add an interactive viewer that allows users to explore the data structure.

Is there something you think we are missing?

Leave a comment below!