Improve Lox Documentation

About the project

• Contact: @onyinyang
• Chat: #tor-anticensorship on irc.oftc.net
• Video room: to be defined.

Participants

• @onyinyang
• anyone else that wants to join

Summary

This is about enhancing the documentation for Lox. Lox will be deployed in alpha early next year. We currently have a Wiki as well as a Lox workspace with some incomplete documentation. Now that development towards the alpha is nearing completion, it would be a good time to make sure that documentation is more comprehensive and up to date.

Project A - Update workspace repository descriptions, build instructions, etc.

• Ensure that each repository in the Lox workspace has an up to date README with comprehensive build/deployment instructions and other information that a user/developer might need
• Ensure that each Lox crate is prepared for publication on crates.io

Project B - Update Lox wiki to provide a better overview of Lox as well as each of the interacting systems and how they work together

• Ensure that the Lox wiki has a comprehensive overview of Lox as well as the related systems it interacts with
• Include documentation for users based on browser UI

Skills

What are the skills needed for the project:

• Knowledge of Lox

Links