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

Documentation rework #689

Merged
merged 38 commits into from
Nov 8, 2024

Conversation

kacperkapusciak
Copy link
Member

@kacperkapusciak kacperkapusciak commented Nov 4, 2024

Description

This PR adds new pages with screenshots and videos showcasing the odds and ends of the Radon IDE extension.

Also, it changes the structure of the documentation by splitting the existing documentation into 3 sections:

  • Getting started describing installation, UI and features overview,
  • Features goes in depth about the all the features provided by the extension,
  • Guides hosts guides that might be useful while using Radon IDE.

Added or overhauled pages

  • Device management
  • User interface
  • Debugging and logging
  • Element inspector
  • Device settings
  • Router integration
  • Previews
  • Keyboard shortcuts
  • Screen recording
  • Storybook integration

Missing pages

  • Touch and multitouch

Testing

Visit the documentation preview provided by Vercel on this PR

Alternatively you can run the documentation from my branch:

cd packages/docs
npm i
npm run start

Copy link

vercel bot commented Nov 4, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
radon-ide ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 8, 2024 11:52am

@maciekstosio
Copy link
Contributor

Have you tested it on different browsers?

Chrome Safari
SCR-20241105-iqtm SCR-20241105-iqqs

@maciekstosio
Copy link
Contributor

What do you think about adding a forward feature to the main page? This is a pretty neat feature that I haven't seen anywhere else.

@maciekstosio
Copy link
Contributor

I'm not good at lawyerish, but this sounds like you can distribute your copies on our channels :D
image

@maciekstosio
Copy link
Contributor

image href mailto ?

Copy link
Contributor

@maciekstosio maciekstosio left a comment

Choose a reason for hiding this comment

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

Few more

packages/docs/docs/guides/troubleshooting.md Outdated Show resolved Hide resolved
packages/docs/docs/guides/troubleshooting.md Outdated Show resolved Hide resolved
No one will notice 🤫
Copy link
Contributor

@maciekstosio maciekstosio left a comment

Choose a reason for hiding this comment

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

lgtm

@kacperkapusciak kacperkapusciak merged commit ca04569 into main Nov 8, 2024
2 checks passed
@kacperkapusciak kacperkapusciak deleted the @kacperkapusciak/document-the-user-interface branch November 8, 2024 12:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants