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

rename to “Framework”; new Getting started tutorial #603

Merged
merged 53 commits into from Feb 1, 2024

Conversation

mbostock
Copy link
Member

@mbostock mbostock commented Jan 25, 2024

This…

This does not

  • Repoint links from cli.observablehq.com to observablehq.com/framework
  • Rename the package from @observablehq/cli to @observablehq/framework
  • Rename the project from @observablehq/cli to @observablehq/framework

These latter changes will follow later.

@mbostock mbostock changed the title “Framework” “Framework”, more docs Jan 25, 2024
docs/getting-started.md Outdated Show resolved Hide resolved
docs/javascript/imports.md Outdated Show resolved Hide resolved
docs/components.md Outdated Show resolved Hide resolved
@mbostock mbostock changed the title “Framework”, more docs rename to “Observable Framework” Jan 29, 2024
docs/getting-started.md Outdated Show resolved Hide resolved
@mbostock mbostock marked this pull request as ready for review February 1, 2024 17:20
docs/getting-started.md Outdated Show resolved Hide resolved
mbostock and others added 3 commits February 1, 2024 10:20
@mbostock mbostock merged commit 47ae519 into main Feb 1, 2024
2 checks passed
@mbostock mbostock deleted the mbostock/framework branch February 1, 2024 18:26
Copy link
Contributor

@mythmon mythmon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new tutorial seems like a good level of depth to me.

One issue I had while reading this is that the screenshots that include VSCode are a little hard to make sense of. I think that's mostly because I'm still using an oldschool 1x display. Maybe we could make those full width on screens with less pixels?

<figcaption>The humble beginnings of a local weather dashboard.</figcaption>
</figure>

<div class="tip">The sidebar is hidden by default in narrow windows. If you don’t see the sidebar, you can show it by making the window wider, or using Command-B (⌘B) or Option-B (⌥B) on Firefox and non-macOS, or clicking the right-pointing arrow ↦ on the left edge of the window.</div>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For me, neither Alt-B nor Ctrl-B work in Chrome or Firefox on Linux or Windows. Super-B works in Chrome on Linux, but nowhere else. Hotkeys are hard :(

docs/getting-started.md Outdated Show resolved Hide resolved
docs/getting-started.md Show resolved Hide resolved
@mbostock
Copy link
Member Author

mbostock commented Feb 1, 2024

I increased the max-width of the figures to 960px. You can right-click and open them in a new window too, if needed, but I think that’s as good as it’ll get.

@mythmon
Copy link
Contributor

mythmon commented Feb 1, 2024

The increased max width on the image helps, thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
5 participants