Editing Google Season of Docs/Project Ideas
From BRL-CAD
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
| Latest revision | Your text | ||
| Line 1: | Line 1: | ||
| − | 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 | + | 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. Here are some links to help you get started with a proposal: |
# [https://brlcad.org/wiki/Compiling Get BRL-CAD source code] | # [https://brlcad.org/wiki/Compiling Get BRL-CAD source code] | ||
| Line 10: | Line 10: | ||
Remember that project descriptions are just ''rough ideas''. You must expand with [[Summer_of_Code/Application_Guidelines|considerably more detail]]. Set goals that fit your experience and interest. | Remember that project descriptions are just ''rough ideas''. You must expand with [[Summer_of_Code/Application_Guidelines|considerably more detail]]. Set goals that fit your experience and interest. | ||
| − | + | ||
| − | = Write an | + | = Write an Introduction to BRL-CAD = |
{|bgcolor=#fff | {|bgcolor=#fff | ||
| Line 28: | Line 28: | ||
|width=10% align=center bgcolor=#eee|morrison, rossberg | |width=10% align=center bgcolor=#eee|morrison, rossberg | ||
|} | |} | ||
| − | |||
| − | + | = Organize all existing BRL-CAD documentation = | |
| − | = | ||
{| bgcolor=#fff | {| bgcolor=#fff | ||
| Line 39: | Line 37: | ||
!align=center|Contacts | !align=center|Contacts | ||
|- | |- | ||
| − | + | |width=62%|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, categorize and organize documentation, make recommendations and/or facilitate with merging overlapping documentation, and present all available documentation in a new web index. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |width=62%|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, | ||
References: | References: | ||
* see doc/ hierarchy in a Subversion checkout | * see doc/ hierarchy in a Subversion checkout | ||
| Line 66: | Line 45: | ||
|width=18% align=center bgcolor=#eee|Mediawiki, Docbook XML, Subversion | |width=18% align=center bgcolor=#eee|Mediawiki, Docbook XML, Subversion | ||
| − | |width=10% align=center| | + | |width=10% align=center|Medium |
|width=10% align=center bgcolor=#eee|yapp, morrison, rossberg | |width=10% align=center bgcolor=#eee|yapp, morrison, rossberg | ||
|} | |} | ||
| − | = Write a | + | = Write a BRL-CAD Primitives manual = |
{| bgcolor=#fff | {| bgcolor=#fff | ||
| Line 84: | Line 63: | ||
* https://brlcad.org/w/images/c/cf/Introduction_to_MGED.pdf | * https://brlcad.org/w/images/c/cf/Introduction_to_MGED.pdf | ||
* http://brlcad.org/tmp/primitives/ | * http://brlcad.org/tmp/primitives/ | ||
| − | |width=18% align=center bgcolor=#eee|Docbook XML, Subversion, | + | |width=18% align=center bgcolor=#eee|Docbook XML, Subversion, C/C++ |
| − | |width=10% align=center| | + | |width=10% align=center|Medium |
|width=10% align=center bgcolor=#eee|morrison, rossberg | |width=10% align=center bgcolor=#eee|morrison, rossberg | ||
|} | |} | ||
| − | = | + | = Upgrade doc infrastructure = |
{| bgcolor=#fff | {| bgcolor=#fff | ||
| Line 97: | Line 76: | ||
!align=center|Contacts | !align=center|Contacts | ||
|- | |- | ||
| − | |width=62%|BRL-CAD | + | |width=62%|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 [https://docusaurus.io Docusaurus] or [https://antora.org Antora], converting everything over while still retaining build system integration. |
References: | References: | ||
| − | * see | + | * see doc/docbook in a source checkout |
* http://brlcad.org/HACKING_BRL-CAD.pdf | * http://brlcad.org/HACKING_BRL-CAD.pdf | ||
| − | + | * https://docbook.org | |
| − | + | * https://docusaurus.io | |
| − | + | |width=18% align=center bgcolor=#eee|Docbook XML, Markdown, Subversion, Docusaurus | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | * https:// | ||
| − | |||
| − | * https:// | ||
| − | |width=18% align=center bgcolor=#eee| | ||
|width=10% align=center|Hard | |width=10% align=center|Hard | ||
|width=10% align=center bgcolor=#eee|yapp, morrison, rossberg | |width=10% align=center bgcolor=#eee|yapp, morrison, rossberg | ||
|} | |} | ||
