Google Season of Docs/Project Ideas
From BRL-CAD
If you want to work on computer-aided design (CAD), geometry, or graphics documentation, you've come to the right place! Please check out our project ideas below. They are roughly in order or priority and difficulty. Here are some links to help you get started with a proposal:
- Get BRL-CAD source code
- Read our existing docs
- Get additional doc perspective
- Read our contributor guide
We will consider GSoD 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. Set goals that fit your experience and interest.
Contents
Migrate doc infrastructure[edit]
| 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 Antora or Docusaurus or MkDocs, converting everything over while still retaining build system integration.
References:
|
Docbook XML, AsciiDoc, Markdown, Antora | Medium | morrison, rossberg, yapp |
Organize all existing user docs[edit]
| 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. There are books, articles, presentations, manual pages, diagrams, reference cards, and more in a variety of formats and locations. The goal of this task to to conduct a complete audit of all existing documentation, catalog them, make recommendations and/or facilitate with merging overlapping documentation, and present all available documentation in a new web index.
References:
|
Mediawiki, Docbook XML, Subversion | Easy | yapp, morrison, rossberg |
Write a "BRL-CAD Primitives" manual[edit]
| 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 an appendix 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.
References:
|
Docbook XML, Subversion, basic reading of C/C++ | Hard | morrison, rossberg |
Organize and publish developer docs[edit]
| Technologies | Difficulty | Contacts | |
|---|---|---|---|
| BRL-CAD uses Doxygen for API documentation. It's a simple way for developers to document API by merely adding /** comments like this */ to their code, typically before a function. The primary goal of this project is to make sure all of the public API has a Doxygen comment, has parameters tagged appropriately, grouped accordingly, and that all groupings are documented as well. The secondary goal is to then publish the output from Doxygen to our website in HTML and PDF forms so that reference documentation is available to everyone.
References:
|
Doxygen, Subversion, C/C++ code comments | Medium | yapp, morrison, rossberg |
Convert unmanaged to managed[edit]
| Technologies | Difficulty | Contacts | |
|---|---|---|---|
| BRL-CAD has several books, presentations, and other documentation written in familiar publishing tools like Microsoft Word, Microsoft Powerpoint, Adobe InDesign, LaTeX, Apple Pages, and more. They are "unmanaged" in the sense that they are not easily kept in sync, unlike the majority of BRL-CAD's docs that are compiled alongside code and easily updated with a text editor (i.e., "managed"). The main reason they are unmanaged is because they have specific layout and formatting. For this project, the goal is to figure out how to manage them so that they're in an editable markup format like AsciiDoc **and** any custom formatting is preserved (e.g., through the use of stylesheets).
References: |
AsciiDoc, Pandoc, Markdown, Docbook XML | Hard | yapp, morrison, rossberg |
