docs: refresh README links

[cnaples79]

Summary

• replace archived documentation URLs with current docs.datafold.com links

Rationale

• README pointed to archived snapshots; using live docs improves accuracy and reduces friction

Changes

• README.md: update dbt guide, CLI reference, and algorithm overview links to current docs URLs

Fixes #29

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request updates the documentation links within the README.md file. The primary goal is to replace previously archived URLs with their current, live counterparts on docs.datafold.com. This change ensures that users always access the most recent and relevant information, enhancing the utility and reliability of the project's documentation.

Highlights

• Documentation Link Refresh: Replaced outdated, archived documentation URLs in the README with current, live links pointing to docs.datafold.com.
• Improved Accuracy and User Experience: The update ensures that users are directed to the most accurate and up-to-date documentation, reducing friction and improving the overall user experience.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• README.md
  • Updated the dbt guide link to point to the live documentation.
  • Refreshed the CLI reference link to the current documentation page.
  • Modified the algorithm overview link to the active documentation.

Activity

• No specific activity has been recorded for this pull request since its creation.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[orca-security-us]

Orca Security Scan Summary

Status	Check	Issues by priority
Passed	Infrastructure as Code	0   0   0   0	View in Orca
Passed	SAST	0   0   0   0	View in Orca
Passed	Secrets	0   0   0   0	View in Orca
Passed	Vulnerabilities	0   0   0   0	View in Orca

[gemini-code-assist]

Code Review

This pull request correctly updates archived documentation links in the README.md to point to the live versions. The changes are a welcome improvement. I've added a couple of suggestions to further enhance the document's readability and accessibility by making some of the link texts more descriptive.

[gemini-code-assist]

For better readability and accessibility, it's best to use descriptive link text. The current text 'documentation' is a bit generic. Consider rephrasing the sentence so the link text clearly indicates its destination, for example, by making 'full command reference' the link text.

Suggested change

	Check out [documentation](https://docs.datafold.com/reference/open_source/cli/) for the full command reference.
	Check out the [full command reference](https://docs.datafold.com/reference/open_source/cli/).

References

1. Links should have descriptive text that indicates the link's destination. This improves readability and accessibility, especially for users of screen readers. Avoid generic link text like 'click here' or 'documentation'.

[gemini-code-assist]

Using 'here' as link text is generally discouraged for accessibility and clarity. It's more helpful to users, especially those using screen readers, if the link text itself describes the content it links to. I suggest changing 'explore [here]' to something more descriptive.

Suggested change

	For detailed algorithm and performance insights, explore [here](docs/technical-explanation.md), or head to our docs to [learn more about how Datafold diffs data](https://docs.datafold.com/data_diff/how-datafold-diffs-data/).
	For detailed algorithm and performance insights, explore our [technical explanation](docs/technical-explanation.md), or head to our docs to [learn more about how Datafold diffs data](https://docs.datafold.com/data_diff/how-datafold-diffs-data/).

References

1. Links should have descriptive text that indicates the link's destination. This improves readability and accessibility, especially for users of screen readers. Avoid generic link text like 'click here' or 'documentation'.