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

Replace README with link to the docs #65

Merged
merged 3 commits into from
Oct 16, 2024
Merged

Replace README with link to the docs #65

merged 3 commits into from
Oct 16, 2024

Conversation

tothmano
Copy link
Contributor

No description provided.

@tothmano tothmano self-assigned this Oct 10, 2024
@tothmano tothmano requested a review from bahlo October 10, 2024 13:02
@Licenser
Copy link
Contributor

I suggest leaving the readme intact and linking it to the docs as an addition. There are a few important things to that.

  1. in the rust ecosystem, it's pretty common to discover over crates.io; crates without a readme are mostly discarded and not considered.
  2. this will also affect docs.rs, so people will now have to go to two places to find docs to the crate
  3. it removes documentation from the integration. The language server and API plugins integrate directly with docs.rs
  4. it makes updating the documentation harder as now updates need to be made in sync.

perhaps replace the first section
image

With a link to our axiom.co docs but leave the quickstart and features in here?

Copy link
Contributor

@Licenser Licenser left a comment

Choose a reason for hiding this comment

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

<3

@tothmano tothmano merged commit 63d4b63 into main Oct 16, 2024
9 checks passed
@tothmano tothmano deleted the mano/update-readme branch October 16, 2024 13:30
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