966016 - Don't generate md files in cfx init

Status: RESOLVED FIXED

(Add-on SDK Graveyard :: Documentation, defect, P2)

Description

[Adrian Aichner [:anaran]]

User Agent: Mozilla/5.0 (Windows NT 5.1; rv:29.0) Gecko/20100101 Firefox/29.0 (Beta/Release)
Build ID: 20140130030202

Steps to reproduce:

Looking in
https://developer.mozilla.org/en-US/Add-ons/SDK/Tools/cfx#cfx_init
I was not able to find any mention of tooling or usage of docs/main.md and README.md


Actual results:

I don't know how to employ .md files as part of firefox add-on development.


Expected results:

I would expect this to be documented or pointed to at
https://developer.mozilla.org/en-US/Add-ons/SDK/Tools/cfx#cfx_init

Perhaps it is also a good time now to mention this subject in
https://github.com/mozilla/addon-sdk/pull/1358

Comment 1

[Will Bamberg [:wbamberg]]

I think really main.md and README.md are kind of relics, and we don't do anything in particular with them. We used to use files under doc to build docs for third-party modules and display them in the source browser, but ever since we stopped supporting locally-generated docs we don't do that any more. I always though of constructing empty files on "cfx init" as just a kind of passive-aggressive way to encourage people to write documentation.

I agree it's a question for jsantell whether we should start doing something with these files in JPM, or whether we should stop generating them altogether in jpm init.

Comment 2

[Jordan Santell [:jsantell] [@jsantell]]

We should probably not generate these unless we have a way to directly use them. If we could have AMO display the content on there or something, that could be useful, but not sure if that's more desirable than what we have currently on AMO

Comment 3

[Erik Vold [:erikvold] (please needinfo? me)]

Attachment: https://github.com/mozilla/addon-sdk/pull/1424

Comment 4

[[github robot]]

Commits pushed to master at https://github.com/mozilla/addon-sdk

https://github.com/mozilla/addon-sdk/commit/a17d1c9a6dd31db3495328bab93dfb4d5c71c28b
Bug 966016 - Do not generate md files in cfx init

https://github.com/mozilla/addon-sdk/commit/b6b553e5defa5a2dd97db9f23fe79c7af15a4467
Merge pull request #1424 from erikvold/966016

Bug 966016 - Do not generate md files in cfx init r=@jsantell