Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set up a mechanism to keep the MDN docs current #6443

Closed
DartBot opened this issue Nov 1, 2012 · 19 comments
Closed

Set up a mechanism to keep the MDN docs current #6443

DartBot opened this issue Nov 1, 2012 · 19 comments
Labels
area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams. closed-not-planned Closed as we don't intend to take action on the reported issue type-enhancement A request for a change that isn't a bug

Comments

@DartBot
Copy link

DartBot commented Nov 1, 2012

This issue was originally filed by @sethladd


The interface for indexedDb.transation() has changed. The last parameter is now a String. The current MDN docs in api.dartlang.org are displaying the older int parameter.

http://api.dartlang.org/docs/bleeding_edge/dart_html/IDBDatabase.html#transaction

I think we need to re-export MDN docs. (and even in this case, looks like MDN has it slightly wrong)

@sethladd
Copy link
Contributor

sethladd commented Nov 1, 2012

Not sure what the right area is for the MDN doc stuff.


Added Area-HTML, Triaged labels.

@dgrove
Copy link
Contributor

dgrove commented Nov 1, 2012

Set owner to amouravski@google.com.

@efortuna
Copy link
Contributor

efortuna commented Dec 6, 2012

Added this to the M3 milestone.

@blois
Copy link
Contributor

blois commented Feb 8, 2013

Removed Area-HTML label.
Added Area-DartDoc label.

@DartBot
Copy link
Author

DartBot commented Feb 8, 2013

This comment was originally written by amouravski@google.com


Appears to be fixed?
http://api.dartlang.org/docs/releases/latest/dart_indexed_db/Database.html#transaction


Added NeedsInfo label.

@sethladd
Copy link
Contributor

sethladd commented Feb 8, 2013

Well, they are all gone. :)

@anders-sandholm
Copy link
Contributor

Removed this from the M3 milestone.
Added this to the M4 milestone.

@DartBot
Copy link
Author

DartBot commented Mar 1, 2013

This comment was originally written by amouravski@google.com


Well, it's definitely the case that MDN docs are out of date.

The only reason that the IndexedDB stuff was working before is because it was actually going down an incorrect path that happened to give semi-decent results.

Specifically, the MDN docs were being reused for IndexedDB from other classes. So, that's why sethladd first saw docs that were somewhat off.


The MDN docs need to be regenerated, and I'm going to take a look at it today, but the code is out of date (and doesn't work as written currently.)
The last time it was updated at all was Aug. 29, 2012: dart-archive/bleeding_edge-DEPRECATED-USE-SDK-INSTEAD@74d2d8a
The last time I can basically confirm it worked was over a year ago on Feb. 7, 2012: dart-archive/bleeding_edge-DEPRECATED-USE-SDK-INSTEAD@ff35a64#dart/utils/apidoc/mdn

The steps that need to happen:

  1. Determine how important keeping MDN docs updated is. The following steps might take a considerable amount of work, compared to writing good docs ourselves. That's a lot of work, too, but might be better over time.

  2. Update the dartIdl.json and domTypes.json. I can't even figure out how these were generated, so, this is probably something that could be bundled with the scripts in tools/dom/scripts . Presumably, when the IDL changes, it should update dartIdl.json. Same with domTypes.json.

  3. Update the scripts under utils/apidoc/mdn to ensure they work. If we're going to keep these scripts around for awhile having some rudimentary tests on them would be helpful.

Further, we're running sh, js, and dart scripts in a row, and I think they're fairly brittle. If we had a simple set of scripts in a single language, I think that'd be better. We could remove the node dependency, at least, and I don't know many people on the team who know how to debug node stuff. I'm not saying we should rewrite all of the scripts, but at one point or another, I think it'll be necessary.

  1. Re-run everything every so often to keep docs fresh.

Please advise.


cc @jacob314.
cc @blois.
Removed the owner.
Added PatchesWelcome label.

@DartBot
Copy link
Author

DartBot commented Mar 1, 2013

This comment was originally written by @sethladd


If we do want to maintain the script, we should consider also pulling docs from webplatform.org. More and more docs will show up there.

@DartBot
Copy link
Author

DartBot commented Mar 1, 2013

This comment was originally written by amouravski@google.com


sethladd: I asked webplatform.org people about that, and they said that it's nowhere near a state where people should be pulling docs from them and it probably won't be for a year or more.

@larsbak
Copy link

larsbak commented May 28, 2013

Removed this from the M4 milestone.
Added this to the M5 milestone.

@alan-knight
Copy link
Contributor

Removed this from the M5 milestone.
Added this to the Later milestone.
Removed Type-Defect label.
Added Type-Enhancement label.
Changed the title to: "Set up a mechanism to keep the MDN docs current".

@anders-sandholm
Copy link
Contributor

Added old-dartdoc label.

@alan-knight
Copy link
Contributor

Issue #16573 has been merged into this issue.

@alan-knight
Copy link
Contributor

Issue #16621 has been merged into this issue.

@kevmoo
Copy link
Member

kevmoo commented Mar 17, 2014

Added Pkg-DartDoc label.

@kevmoo
Copy link
Member

kevmoo commented Mar 17, 2014

Removed Area-DartDoc label.
Added Area-Pkg label.

@kevmoo
Copy link
Member

kevmoo commented Apr 7, 2014

Removed Pkg-DartDoc label.
Added Pkg-DocGen label.

@efortuna
Copy link
Contributor

efortuna commented May 9, 2014

Issue #17977 has been merged into this issue.

@DartBot DartBot added Type-Enhancement area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams. closed-not-planned Closed as we don't intend to take action on the reported issue labels May 9, 2014
@kevmoo kevmoo added type-enhancement A request for a change that isn't a bug and removed type-enhancement labels Mar 1, 2016
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams. closed-not-planned Closed as we don't intend to take action on the reported issue type-enhancement A request for a change that isn't a bug
Projects
None yet
Development

No branches or pull requests

9 participants