Skip to content


Thunderbird 3.0 docs - MDC structure and stubs

Hi all. As of tomorrow, I’m off on a summer break. I’ve set up some templates and stub pages on MDC that I hope will help everyone write docs as they find time.

Start with the Overview page. There is a section for each Thunderbird “component” (ie, the address book, the message list, etc). Each section has a brief functional description, a list of the related interfaces, some ideas about what extensions developers could do, and a TODO list.

Although there are a few exceptions to compensate for existing material, in general each component also has:

  • A page that describes the interfaces related to the component (linked to the component’s section on the  Overview page)
  • One or more pages that provides examples (linked to the component’s section on the Overview page). If the existing examples were snippets or non-existent, there is a single page with multiple examples. If the examples were large (like tutorials), there is a single page per example.
  • In some cases (such as Gloda), there is also an overview page specific to the component that goes into greater detail about thecomponent itself.

Some of these pages have content; some do not. Where there is content, some of it is recent and relevant, some is not.

To help out with the docs, go to the Overview page. Look at the TODO section for the component that interests you. Replace the prefix “who?” with your name. When you complete the TODO, put a strike-through over the text.

(If the TODO item is prefixed with someone’s name but has a question mark, that means that I made a guess that the assigned person would be the one to do it. If you want to take it over, talk to the assigned
person.)

If you create new pages (feel free to do so) please add the following templates to the top of the page (below the title):

{{template.Tb_minversion_header(3)}}
{{template.draft("")}}

Thanks in advance to everyone who helps out!

Posted in MDC, extension docs, thunderbird.


One Response

Stay in touch with the conversation, subscribe to the RSS feed for comments on this post.

Continuing the Discussion

  1. Standard8’s Blog » Blog Archive » Thunderbird 3 Beta 4 Schedule linked to this post on August 19, 2009

    [...] We want to improve our documentation - especially for extension developers (but for ourselves as well), see Jen’s blog for how to help. [...]



Some HTML is OK

or, reply to this post via trackback.