Google Season of Docs/Project Ideas

Revision as of 15:35, 22 April 2019 by Sean (talk | contribs) (add doc infrastructure)

If you want to work on computer-aided design (CAD), geometry, or graphics documentation, you've come to the right place! Help us improve open source BRL-CAD.

Get started quickly by:

  1. Compiling BRL-CAD from source
  2. Reading our existing docs
  3. Getting some additional doc perspective
  4. Reading our contributor guide

Well prepared proposals from capable technical writers have a good chance of getting selected. We consider proposals for all skill levels ranging from simple to crazy hard and everything in between. Introduce yourself via chat (preferred) or via e-mail, and we'll help you plan a project right for you.

Remember that project descriptions are just rough ideas. You must expand with considerably more detail. Change the goals to fit your experience and interests.

Write an Introduction to BRL-CAD

Technologies Difficulty Contacts
This is as straight-forward as it sounds, write an introduction intended for users discovering BRL-CAD for the first time. It should minimally cover installation, an overall description of capabilities, of the runtime philosophy, basic usage of major tools, modeling, and rendering.


Docbook XML Easy morrison, rossberg

Organize all existing BRL-CAD documentation

Technologies Difficulty Contacts
Tame the beast. BRL-CAD has more than a million words of documentation spread across hundreds of documents. Some are huge, some are small. The goal of this task to to conduct a complete audit of all existing documentation, categorize and organize documentation, make recommendations and/or facilitate with merging overlapping documentation, and present all documentation in a new web index.


Mediawiki, Docbook XML, Subversion Medium morrison, rossberg

Write a BRL-CAD Primitives manual

Technologies Difficulty Contacts
BRL-CAD has approximately 2 dozen primitives. New users learning how to model with BRL-CAD for the first time end up utilizing Appendix A in our existing MGED Tutorial Series, which is a brief guide to some of the supported primitives. For this project, we'd like all primitives to be documented with rendered visuals where appropriate, explanation of all parameters, and depiction of the variety possible with each primitive.


Docbook XML, Subversion, C/C++ Hard morrison, rossberg

Upgrade doc infrastructure

Technologies Difficulty Contacts
BRL-CAD has extensive documentation infrastructure using Docbook XML whereby we "compile" them into HTML, PDF, and other formats. This approach helps ensure docs remain up-to-date, without syntax/structure errors, and allows the documentation to be composed and reused in different ways (e.g., an tutorial on some topic might get embedded as an appendix in one document or a chapter to another). That said, the underlying format is tedious to write and hard for contributors. We'd like to migrate to a newer system like Docusaurus or Antora, converting everything over while still retaining build system integration.


Docbook XML, Markdown, Subversion, Docusaurus Hard morrison, rossberg