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

Add API reference links in navbar dropdown #59

Merged
merged 1 commit into from
Mar 5, 2024

Conversation

kid-icarus
Copy link
Contributor

This adds a dropdown to the navbar with a couple of links for the API reference for JS and Rust versions of Automerge. I can add more, but just wanted to see folks agree with the direction first.

Screen.Recording.2024-03-02.at.12.45.50.PM.mov

@pvh
Copy link
Member

pvh commented Mar 4, 2024

This is a good start! Do we have appropriate Swift docs as well, @heckj?

@pvh
Copy link
Member

pvh commented Mar 4, 2024

Glanced at the code -- we probably ought to set things up so we don't have a hardcoded point release in the rust link as well. That can really come back to bite you with Google search results as well. Any thoughts, @alexjg?

@heckj
Copy link
Contributor

heckj commented Mar 4, 2024

definitely: https://automerge.org/automerge-swift/documentation/automerge/

And I'd recommend using the link https://docs.rs/automerge/latest/automerge/ for the Rust docs so that the docs stayed tracking the 'latest' version, rather than being pinned to 0.5.7 - we'll never remember to look for an update that on releases... (at least I wouldn't)

@kid-icarus kid-icarus force-pushed the add-api-ref-dropdown branch from 7a15958 to 0205e8f Compare March 4, 2024 17:49
@kid-icarus
Copy link
Contributor Author

kid-icarus commented Mar 4, 2024

Ah I didn't notice the version hard coded in the URL, updated the link and also added one for the Swift docs 👍🏻

@alexjg alexjg merged commit 28e3011 into automerge:main Mar 5, 2024
1 check passed
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.

4 participants