Skip to content

Conversation

@josh-wong
Copy link
Member

@josh-wong josh-wong commented Apr 24, 2025

Description

This PR updates the root-level README to guide visitors of this repository to beginner-level documentation on the ScalarDL docs site. By listing specific docs and short explanations, we can help guide visitors to docs that may help them get started with using ScalarDL.

Related issues and/or PRs

For consistency, I've updated the README in the scalar-labs/scalardb repository:

Changes made

  • Revised the Docs section to include links to getting-started tutorials, configurations, and features on the docs site.
  • Added a link to the ScalarDL overview page to the end of the introductory paragraph.

Checklist

The following is a best-effort checklist. If any items in this checklist are not applicable to this PR or are dependent on other, unmerged PRs, please still mark the checkboxes after you have read and understood each item.

  • I have commented my code, particularly in hard-to-understand areas. N/A
  • I have updated the documentation to reflect the changes. N/A
  • I have considered whether similar issues could occur in other products, components, or modules if this PR is for bug fixes. N/A
  • Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.). N/A
  • Tests (unit, integration, etc.) have been added for the changes. N/A
  • My changes generate no new warnings. N/A
  • Any dependent changes in other PRs have been merged and published. N/A

Additional notes (optional)

N/A

Release notes

N/A

Copy link
Contributor

@kota2and3kan kota2and3kan left a comment

Choose a reason for hiding this comment

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

Thank you for the updates!
I left minor suggestions.
Please take a look when you have time! 🙇‍♂️

@josh-wong josh-wong requested a review from kota2and3kan April 25, 2025 03:13
@josh-wong josh-wong force-pushed the revise-docs-section-of-README branch from 2f16f20 to e67972a Compare April 25, 2025 03:15
Copy link
Contributor

@kota2and3kan kota2and3kan left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you!

Copy link
Collaborator

@jnmt jnmt left a comment

Choose a reason for hiding this comment

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

LGTM, thank you! I left a minor suggestion that doesn't block merging the PR.

Copy link

@choplin choplin left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor

@feeblefakie feeblefakie left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you!
I left a comment about what to show.

@josh-wong josh-wong merged commit 92c1620 into master May 8, 2025
7 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants