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

Consider adding a redirect system for language feature specifications similar to Flutter design docs #5079

Open
parlough opened this issue Jul 25, 2023 · 1 comment
Labels
a.language Relates to the Dart language tour co.proposal Community ask to change an approach or process for docs.Dart.dev e2-days Can complete in < 5 days of normal, not dedicated, work fix.link Adds, changes, or removes a link to a page from.team Reported by Dash docs team member infra.structure Relates to the tools that create dart.dev p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface.

Comments

@parlough
Copy link
Member

Currently it's a bit awkward to link to feature specifications on the language repository. When they are being worked on, then accepted, then released, their link changes every time. Beyond that, the links are long and definitely not memorable.

Developers often love to see what's coming, learn from the specifications, track them, share them, etc. We also use these links occasionally on dart.dev.

We should consider tracking redirects that we handle updating, so we can have a persistent link to link to from anywhere, sort of similar to Flutter design docs that live at flutter.dev/go/.

This could be done on this repository, but it would probably be better on the language repository's spec.dart.dev Firebase instance, which would allow atomic updates of the redirects as the documents move. Then we could add a single redirect from dart.dev to spec.dart.dev for those design docs.

If we managed this in dart-lang/language, the workflow would look like:

  1. When adding a design doc:
    1. Add the redirect to dart-lang/language's firebase.json under a name /feature-spec/class-modifiers or something similar.
    2. Add the dart.dev redirect link to the document at the top of the feature specification itself for easy sharing.
  2. When moving it to a different directory, replace the destination URL.

\cc @MaryaBelanger

@parlough parlough added a.language Relates to the Dart language tour p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. e2-days Can complete in < 5 days of normal, not dedicated, work co.proposal Community ask to change an approach or process for docs.Dart.dev fix.link Adds, changes, or removes a link to a page labels Jul 25, 2023
@atsansone atsansone added the from.team Reported by Dash docs team member label Aug 8, 2023
@mit-mit
Copy link
Member

mit-mit commented Apr 4, 2024

Should we just go with dart.dev/go/ ? We still have time to change #5684 to /go/macros...

@antfitch antfitch added p.class-modifiers infra.structure Relates to the tools that create dart.dev and removed st.triage.ltw p.class-modifiers labels Mar 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a.language Relates to the Dart language tour co.proposal Community ask to change an approach or process for docs.Dart.dev e2-days Can complete in < 5 days of normal, not dedicated, work fix.link Adds, changes, or removes a link to a page from.team Reported by Dash docs team member infra.structure Relates to the tools that create dart.dev p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface.
Projects
None yet
Development

No branches or pull requests

4 participants