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.

Sign up for GitHub

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

Jump to bottom

Expand dart doc with information from dartdoc README and wiki #4347

Open
timsneath opened this issue Nov 7, 2022 · 1 comment
Open

Expand dart doc with information from dartdoc README and wiki #4347

timsneath opened this issue Nov 7, 2022 · 1 comment
Labels
a.reference Relates to reference material section of dart.dev e1-hours Can complete in < 8 hours of normal, not dedicated, work p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged t.cli-tools Relates to the dart command line tools

Comments

@timsneath
Copy link
Contributor

timsneath commented Nov 7, 2022 •
edited by atsansone
Loading

Page URL

https://dart.dev/tools/dart-doc

Page source

https://github.com/dart-lang/site-www/tree/main/src/content/tools/dart-doc.md

Describe the problem

https://github.com/dart-lang/dartdoc contains a lot more documentation that is missing from the dart doc page.

Note: This information is almost entirely from the Advanced section.

Expected fix

We should move this across or at least link to it.

Additional context

No response
@timsneath timsneath changed the title [PAGE ISSUE]: 'dart doc' [PAGE ISSUE]: dart doc is missing information that is needed to use this tool Nov 7, 2022
@parlough parlough added p2-medium Necessary but not urgent concern. Resolve when possible. t.cli-tools Relates to the dart command line tools docs e1-hours Can complete in < 8 hours of normal, not dedicated, work e2-days Can complete in < 5 days of normal, not dedicated, work labels Nov 7, 2022
@atsansone atsansone removed the docs label Apr 29, 2023
@atsansone atsansone changed the title [PAGE ISSUE]: dart doc is missing information that is needed to use this tool Expand dart doc with information from GitHub README May 3, 2023
@atsansone atsansone added st.triage.ltw Indicates Lead Tech Writer has triaged a.reference Relates to reference material section of dart.dev and removed e2-days Can complete in < 5 days of normal, not dedicated, work labels May 3, 2023
@parlough parlough mentioned this issue Oct 11, 2023
Merged
1 task
@parlough parlough changed the title Expand dart doc with information from GitHub README Expand dart doc with information from dartdoc README and wiki Oct 11, 2023
@parlough
Copy link
Member

parlough commented Oct 11, 2023 •
edited
Loading

As a note for when we work on this, the old dartdoc wiki has a lot of content that would be good to formally document as well. Some pieces may not yet be stable/guaranteed enough to include to on dart.dev, but a lot of it would be great.

For comment references in particular, refer to dart-lang/sdk#50702 for current/future work in that area.

@parlough parlough mentioned this issue Jan 30, 2024
Merged
parlough added a commit that referenced this issue Feb 15, 2024
@parlough @atsansone
Expand documentation of dart doc (#5494)
6c5d2d7 
Contributes to dart-lang/sdk#54721 and
#4347

---------

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
atsansone added a commit to atsansone/site-www that referenced this issue Feb 20, 2024
@parlough @atsansone
Expand documentation of dart doc (dart-lang#5494)
ceed2dc 
Contributes to dart-lang/sdk#54721 and
dart-lang#4347

---------

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
atsansone added a commit to atsansone/site-www that referenced this issue Mar 22, 2024
@parlough @atsansone
Expand documentation of dart doc (dart-lang#5494)
c8d6d6b 
Contributes to dart-lang/sdk#54721 and
dart-lang#4347

---------

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
@atsansone atsansone self-assigned this May 15, 2024
@atsansone atsansone removed their assignment Jul 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
a.reference Relates to reference material section of dart.dev e1-hours Can complete in < 8 hours of normal, not dedicated, work p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged t.cli-tools Relates to the dart command line tools
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@atsansone @timsneath @parlough