123230 - We need a coding introduction for Mozilla

Status: RESOLVED FIXED

(Developer Documentation Graveyard :: Mozilla Platform, defect)

Description

[Kai Engert (:KaiE:)]

I have written an introduction that might help developers to get started with
developing Mozilla.

I'm looking for reviewers, and eventually we might want to publish it on
Mozilla.org.
This bug could also be used to track modifications / requests to the document.

The document currently lives at:
  http://www.kuix.de/mozilla/coding-introduction.html

Comment 1

[mental]

Looks like it's now up at mozilla.org:

http://www.mozilla.org/hacking/coding-introduction.html

Comment 2

[James Cox]

accepting QA for mozilla developer docs.

some of these bugs have been around for a _long_ time. Reporters, would you
please review the bugs, see if the issues have been resolved, and close bugs
appropriately.

I will do a full review of all bugs not touched in one week (8th April). 

Thanks.

</spam>

Comment 3

[Kai Engert (:KaiE:)]

The introduction now exists, I suggest we keep this bug open for tracking chang
requests.

Comment 4

[Neil Becker]

"A broken tree sucks."
gotta love it...

Comment 5

[Tim Burke]

The intro document mentions that more and more interfaces will be frozen as Mozilla "approaches the magical version number One-Dot-Zero". 

Well, we're there. Is there a document which summarizes the frozen interfaces? Seems like it could be useful, with a link embedded in the intro document.

Comment 6

[Prognathous]

This is an excellent document, but it could use some more links. Here's an example:

"If you are developing only on one combination of operating system and compiler,
and you are not paying attention to the portability rules (read the documents on
mozilla.org)"

IMO, such references should be linked, (in this case
http://www.mozilla.org/hacking/cpp_portability )

Prog.

Comment 7

[steve.swanson]

There are several ' when I view http://mozilla.org/hacking/coding-
introduction.html.

Comment 8

[Mika Pruikkonen]

Confirming the above in IE (version 6.0.2800.1106 at least). Dunno if you
want to fix it or not, but maybe you could just write "It's" as "It's"
-- most of the rest of mozilla.org seems to be doing that.

Comment 9

[Gary Turovsky]

There is a small mistake.  This should be "a", not "an".

“Instead you define an descriptive identifier for your text, which is used in
your C++ or JavaScript file.”

Comment 10

[Manuel Vázquez Acosta]

Small "bug" in Strings in C++ section. It says: "Sometimes you just need to
fixed size string", it should say: "Sometimes you just need a fixed size
string", with a n "a" instead of a "to".

Regard, Manuel.

Comment 11

[Ka'ala Yezbick]

Typo: "It is based of the Linux project's glimpse engine with internal
modifications."  ("of" should be "on").  
Cheers, Ka'ala Yezbick

Comment 12

[Nickolay_Ponomarev]

We should just migrate that to MDC and close this bug.

Comment 13

[Bryan Price]

Attachment: Grammar/punctuation/spelling/readability patch.

I made several minor grammar/punctuation/spelling and readability changes that I think might help this great introductory document. I considered explaining the CORBA acronym but did not. Please check the XUL readability changes to be sure I didn't misrepresent the original "action controls react to" phrasing.

Comment 14

[Nickolay_Ponomarev]

Bryan: This patch is unlikely to get applied, unless you drag it through the review and check-in process. If you have time, I suggest migrating the original document to developer.mozilla.org instead and making your change in the wiki version afterwards. Thanks

Comment 15

[Hendrik Lönngren]

I have ported the document to http://developer.mozilla.org/en/docs/An_Introduction_To_Hacking_Mozilla.

Comment 16

[John Karahalis [:openjck]]

Automatically closing all bugs that have not been updated in a while. Please reopen if this is still important to you and has not yet been corrected.

Comment 17

[John Karahalis [:openjck]]

Reopening for review by Sheppy.