README files in (most) every directory

RESOLVED WONTFIX

Status

Developer Documentation
General
RESOLVED WONTFIX
5 years ago
2 years ago

People

(Reporter: Jeff Hammel, Unassigned)

Tracking

Details

(Whiteboard: u=mozdev p=0 c=General)

(Reporter)

Description

5 years ago
It would be nice if each directory (for the most part) had a README file detailing what was in that directory.  As a use case consider bug 836079.  ABICT from MXR and MDN, this file isn't used.  Probably, the whole testing/tools directory is obselete and should be deleted.  However, its hard to know the intention of these files.  If there were READMEs here, I would know why these files were here and what they did (one would hope!).

In a perfect world, MXR, MDN, etc would make use of these README files if present as part of the documentation effort.

Leaving this as a pretty vague bug for the purposes of discussion.
I'm not sure this is technically a developer documentation issue; it's the sort of thing that would have to be taken up with the dev team.
Whiteboard: u=mozdev p=0
Whiteboard: u=mozdev p=0 → u=mozdev p=0 c=General
Status: NEW → RESOLVED
Last Resolved: 2 years ago
Resolution: --- → WONTFIX
You need to log in before you can comment on or make changes to this bug.