-
Notifications
You must be signed in to change notification settings - Fork 704
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
Break up the Language Tour #4612
Conversation
Visit the preview URL for this PR (updated for commit e868b37): https://dart-dev--pr4612-language-tour-2-97gcxvq9.web.app (expires Fri, 17 Mar 2023 22:40:46 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: d851bc446d3c4d7394c5406c6f07255afc7075f3 |
See #4610 (comment) for my thoughts on libraries and visibility:
|
@parlough where do you think the library content should go? Does it make sense as an entry under "variables & expressions"? (not knowing where to put it definitely influenced my impulse to move it under libraries 🙃 ) |
I don't think Variables and expressions is the right place. @MaryaBelanger Perhaps a first-level doc called Libraries and imports before Classes and objects. I don't believe imports are used much or at all before then. I say and imports instead of and visibility because (I imagine) that's what most people will have the context to search/look for. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As discussed, I would move control flow and error handling up, but otherwise LGTM!
GREAT JOB!
Looks great overall! A few comments:
|
@parlough can you elaborate a bit on that? I was actually thinking that might be a good place (I'd just call the page |
Libraries aren't really about variables or expressions, they are a more high-level concept core to using Dart, nor is Overall, the current Variables and expressions section doesn't make a lot of sense to me. If I'm looking to learn about Libraries, Metadata, or Comments, I would not think to expand Variables and expressions. None of them are (solely) about variables or expressions. Perhaps the problem is in the name of the section rather than the placement of these pages? |
6a0254a
to
a1d9688
Compare
I took everyone's comments into consideration and came up with the following structure as a compromise for the time being, as I need to merge this so I can start placing new Dart 3 pages in the new structure:
Please open a new issue if anything isn't sitting right. Especially if it's really egregious, I'll try to fix it ASAP. Thanks all! |
Staged: https://dart-dev--pr4612-language-tour-2-koullabo.web.app/
Waiting for #4604 to merge first -- Fixes #4588
This PR breaks sections of the language tour into separate pages and lists them directly under "Language" in the side nav, so the features of the Dart language are visible and navigable more easily than the previous single page.
(see #4588 and #4565 for background; see Kotlin and Swift docs for inspiration/direction)
What this PR is:
Addressing the side nav and new organization. Please comment and review the new layout of the side nav under "Language".
Addressing the grouping of info on the new pages. Please let me know if the new page groupings make sense. They almost entirely follow the structure of original Language Tour -- I didn't write that, I won't be improving that structure in this PR beyond what's necessary.
Fixing links to the old language tour page.
Adding manual redirect links to old language tour page
TODO:
In this PR...
/language-tour
/#<section>
to change to new page/location/language-tour
page from showing up in search resultsWhat this PR is not:
This PR is not...
TODO:
In future PRs...
Core library changes/language/async
page.