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

Show dev / main-branch docs too #159

Open
huonw opened this issue Feb 22, 2024 · 1 comment
Open

Show dev / main-branch docs too #159

huonw opened this issue Feb 22, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@huonw
Copy link
Contributor

huonw commented Feb 22, 2024

Per #155 (comment), docs from the main branch are rendered, but hidden from the version selector dropdown to reduce the noise/keep it streamlined.

E.g. https://www.pantsbuild.org/2.20/docs/introduction/welcome-to-pants is available but not visible in the dropdown:

image

This was discussed briefly on slack and there seemed to be a bit of a consensus that they should be shown. This would help, for instance, reviewing/validating the docs and people doing pre-release testing of new features.

@huonw huonw added the enhancement New feature or request label Feb 22, 2024
@huonw huonw self-assigned this Feb 29, 2024
huonw added a commit that referenced this issue Mar 12, 2024
The goal here is to centralise the logic around versions, creating a
list of all the details about each version (e.g. full version number,
whether it's a pre-release or unmaintained etc.), that downstream
processing can reference directly rather than recompute. This, for
instance, eliminates the duplicated logic around which versions are
maintained.

The goal here is to make changes like #174 (and maybe #159) easier. This
PR doesn't/shouldn't change observable behaviour.

This also removes the explicit `disableVersioning` flag, since that
seems to require changing the contents of the `versions` map. Instead
the existing use of `onlyIncludeVersions` seems to do what's intended:
make dev builds faster. An `npm start` build takes about 10s both with
the old `disableVersioning` setting, or just relying on
`onlyIncludeVersions`.

This includes some cut-and-paste rearrangement too that makes the diff
harder to understand. The commits are individually reviewable.
@huonw huonw removed their assignment Mar 12, 2024
@huonw
Copy link
Contributor Author

huonw commented Mar 12, 2024

I've adjusted how the versions are configured, in #176, but won't finish this off now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant