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

Fix link to internal and external types #4

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

Fix link to internal and external types #4

wants to merge 30 commits into from

Conversation

taras
Copy link
Member

@taras taras commented Jan 9, 2025

Motivation

We want users to be able to navigate between types in Contrib and Effection library.

Approach

I needed the following pieces,

  1. I needed to know what version of Effection library the Contrib is using. I'm using jsr:@deno/graph to extract dependencies for the entrypoint of the contrib
  2. I needed all of the versions of the libraries to be linkable. We didn't want to create a separate section for every doc version, so we're only showing minor releases and linking to those minor releases.

Screenshots

Showing previous minor versions

image

Each minor release shows latest version in that release

It also shows a message that this documentation might be outdated relative to the latest release.

image

Showing a link to API Ref from contribs

image

TODO

  • There is a bug linking to 4.0.0 from Contrib (I'll look into it)
  • I need to review mobile responsive screens

@cowboyd
Copy link
Member

cowboyd commented Jan 9, 2025

This looks really amazing!

a few clarifications, opinions:

  1. I thought we weren't going to show api docs for patch releases, but only for minor versions. The reason being that minor versions should all have the exact same API.
  2. I don't think the "potentially outdated" message should be quite so salient. We should still have it, but it should lightly direct you to the latest, not indicate that something is very wrong. perhaps something like "3.0 (latest 3.1)" where "latest" is a link to the the 3.1 docs. It is very common to be looking at an older version of the API, especially if you're codebase has yet to migrate.

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