Closed
Bug 1306595
Opened 8 years ago
Closed 8 years ago
Feedback on gecko.rst, syntax.rst
Categories
(L20n :: Evangelism, defect)
L20n
Evangelism
Tracking
(Not tracked)
RESOLVED
FIXED
People
(Reporter: Pike, Assigned: zbraniecki)
Details
Attachments
(2 files)
I read through https://github.com/l20n/l20n.js/blob/master/docs/gecko.rst and https://github.com/l20n/l20n.js/blob/master/docs/syntax.rst. Maybe that's just personal taste, but I wonder if we'd better document things with question first, then answer, then example. The old beast of physics vs math in writing text, really. Re gecko.rst: Let's rephrase the doc to talk about DOM, and not XUL. Just so that we don't get stuck in politics. I'd move all of FTL into the syntax doc. We shouldn't mention en-US in the discovery path, I think that's confusing. Link resources talk about <head> in html, and not xul/xbl? We should separate out the documentation on bundles, and hand it a specific use-case. I wonder if the JavaScript API should be one to be used in jsm's, too. Maybe in a separate doc? Re FTL syntax, I'd throw away the mention of MessageFormat. I doubt anybody involved in gecko/firefox hacking cares. I wonder if we should rephrase the "localizers can do stuff" to something that talks to Firefox developers? Something like "some things should be implemented in l20n, so that they can be replaced with localized implementations as needed". Might need some examples? syntax.rst: Can we make the intro more lightweight and less intimidating? The whitespace handling is a bit vague. Also not sure if we're using | as an operator here, maybe just call it mark-up? I'd do entity references first, then interpolation, and then builtins (just because I prefer the non-sigil version first).
|
Assignee | |
Updated•8 years ago
|
Status: NEW → RESOLVED
Closed: 8 years ago
Resolution: --- → FIXED
You need to log in
before you can comment on or make changes to this bug.
Description
•