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

doc: add extra link to runtimes to make it more discoverable #185

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

alexbozhenko
Copy link
Contributor

No description provided.

@alexbozhenko
Copy link
Contributor Author

cc @aricart

@aricart
Copy link
Member

aricart commented Jan 9, 2025

Isn't this duplicating what is said on the top level readme which is really the landing page for the repo?

@alexbozhenko
Copy link
Contributor Author

@aricart
It does, but that important doc is not included anywhere in https://nats-io.github.io/nats.js/
So if someone is reading it at
https://nats-io.github.io/nats.js/core/index.html
they will find the link there.

I guess we should not assume that users will read all the docs in proper order, starting from readme.md.
They can end up there from google search, etc...
So having this extra link may reduce number of questions of the kind that I have been asking you

@aricart
Copy link
Member

aricart commented Jan 10, 2025

It is on the top readme!

@alexbozhenko
Copy link
Contributor Author

alexbozhenko commented Jan 10, 2025

@aricart
Link to runtime is present in the middle of the readme:
image

But it doesn't help me if I, e.g. end up at https://nats-io.github.io/nats.js/core/index.html or https://github.com/nats-io/nats.js/tree/main/core from google search

I feel like having this(a link) duplicated won't hurt, but may help, so worth adding it?

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