Skip to content

v3.0.0a1: Bump IDOM to 1.0.0 pre-release #125

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

Merged
merged 6 commits into from
Feb 2, 2023

Conversation

Archmonger
Copy link
Contributor

@Archmonger Archmonger commented Feb 2, 2023

Description

  • Modify docs to use the upcoming IDOM-Core docs styling
    • Move docs python examples to individual files so we can run tests on them
    • CI for type checking + linting docs examples
    • Minor wording and section naming changes to feel more React-like
  • Bump IDOM to 1.0.0 pre-release
    • Use the new idom.html API
    • Update package.json to be compatible with idom>=1.0.0
  • Make the main requirements.txt be fully inclusive of all dev/user/docs dependencies to simplify development workflow
  • Update setup.py to automatically install the latest NPM, and be easier to debug when things fail

Checklist:

Please update this checklist as you complete each item:

  • Tests have been included for all bug fixes or added functionality.
  • The changelog has been updated with any significant changes, if necessary.
  • GitHub Issues which may be closed by this PR have been linked.

@Archmonger
Copy link
Contributor Author

Archmonger commented Feb 2, 2023

@rmorshea Can you pull down this branch and check out the new docs styling with mkdocs serve?

I went pretty deep into making it feel React-like.

@Archmonger Archmonger marked this pull request as ready for review February 2, 2023 04:55
@Archmonger Archmonger requested a review from rmorshea February 2, 2023 04:56
@Archmonger Archmonger changed the title v3.0.0-a1: Bump IDOM to 1.0.0 pre-release v3.0.0a1: Bump IDOM to 1.0.0 pre-release Feb 2, 2023
@rmorshea
Copy link
Contributor

rmorshea commented Feb 2, 2023

requirements.txt is a little out of date with the current requirements/*.txt files. Can you update it to:

-r requirements/build-docs.txt
-r requirements/build-pkg.txt
-r requirements/check-style.txt
-r requirements/check-types.txt
-r requirements/dev-env.txt
-r requirements/pkg-deps.txt
-r requirements/test-env.txt
-r requirements/test-run.txt

@rmorshea
Copy link
Contributor

rmorshea commented Feb 2, 2023

Overall, I think the docs look great. I'm excited to have the core docs done in this style. The only criticism I have at the moment is that there may be some over reliance on admonitions. I don't have any alternate suggestions at the moment, but this is a thought I had when looking at this particular case:

image

@rmorshea
Copy link
Contributor

rmorshea commented Feb 2, 2023

I'm realizing I completely forgot to checkout this branch when I checked out the docs. The similarity to React's docs is uncanny! In some ways I prefer the mkdocs styling. I always found this part of the sidebar in the beta docs to be busy and distracting for some reason:

image

and since mkdocs doesn't have that the left sidebar is much more readable.

@Archmonger
Copy link
Contributor Author

I considered replicating the react docs sidebar while doing this styling. But ultimately agreed with you that I think mkdocs layout is better.

Additionally if we did that, we'd be changing the mkdocs jinja templates, which is more prone to catastrophically breaking under future updates of mkdocs.

@Archmonger
Copy link
Contributor Author

Archmonger commented Feb 2, 2023

requirements.txt is a little out of date with the current requirements/*.txt files. Can you update it to:

I left test-run.txt out since it seems like you're already installing it within dev-env.txt. I will re-add it for completeness.

Copy link
Contributor

@rmorshea rmorshea left a comment

Choose a reason for hiding this comment

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

I say we get this in so it's easier to install and test out. Since it's a pre-release it shouldn't be a huge problem if its buggy.

@Archmonger Archmonger merged commit 9fd30aa into reactive-python:main Feb 2, 2023
@Archmonger Archmonger deleted the 3.0.0-a1 branch February 3, 2023 02:49
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