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

Improve getting started doc section #5689

Merged
merged 19 commits into from Mar 27, 2024
Merged

Conversation

Wumpf
Copy link
Member

@Wumpf Wumpf commented Mar 26, 2024

What

Various improvements to the getting started doc sections:

  • better layout / new nesting structure
  • improved titles, updated some references accordingly
  • better & more complete install instructions
  • remove 'Welcome' page, make index == new "What is Rerun?" page

⚠️ adds a placeholder page for getting started on blueprint

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested the web demo (if applicable):
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG
  • If applicable, add a new check to the release checklist!

@Wumpf Wumpf added 📖 documentation Improvements or additions to documentation include in changelog labels Mar 26, 2024
Copy link
Member

@emilk emilk left a comment

Choose a reason for hiding this comment

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

Great

docs/content/getting-started/data-in.md Outdated Show resolved Hide resolved
docs/content/getting-started/installing-viewer.md Outdated Show resolved Hide resolved
docs/content/getting-started/installing-viewer.md Outdated Show resolved Hide resolved
docs/content/getting-started/visualize/blueprint.md Outdated Show resolved Hide resolved
docs/content/getting-started/what-is-rerun.md Show resolved Hide resolved
@emilk emilk self-assigned this Mar 27, 2024
Copy link

Size changes

Name main 5689/merge Change
Wasm 18.67 MiB 20.03 MiB +7.28%

@emilk emilk merged commit bd2f64a into main Mar 27, 2024
31 checks passed
@emilk emilk deleted the andreas/simplify-getting-started branch March 27, 2024 17:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation include in changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Simplify Getting Started Section of Documentation
2 participants