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

README seems not up to date #422

Open
fe51 opened this issue Jan 28, 2025 · 2 comments
Open

README seems not up to date #422

fe51 opened this issue Jan 28, 2025 · 2 comments
Labels
awaiting response topic: docs Improvements or additions to documentation

Comments

@fe51
Copy link
Member

fe51 commented Jan 28, 2025

Hi there,

Thanks a lot for the recent PR leading to the new data model logic !

I have the feeling that the README is not up to date.

Would it be possible to updates it according to the recent refacto ?

Thanks a lot 🙏

@fe51 fe51 added the topic: docs Improvements or additions to documentation label Jan 28, 2025
@frgfm
Copy link
Member

frgfm commented Jan 28, 2025

Hey there, mind sharing what's giving you this feeling? 🙏
(apart from the screenshot, and perhaps the very last commit updates on the env variable description in CONTRIBUTING.md, I think it's up to date)

@fe51
Copy link
Member Author

fe51 commented Jan 29, 2025

Hehe you are right, it is mainly due to the screenshot :)

Apart for it, I have two questions :

  • As long as we need poetry to run main main commands, should python or poetry tool be in Installation/Prerequisites ?
  • Also, maybe in the installation section (or somewhere in the readme) you could point to CONTRIBUTING for more explanations on the organisation of the repo and the logic of the api (data model etc) ? In my opinion, CONTRIBUTING here is very interesting and not only related to contributing guideline. It's an open question, at the very least, these details are provided, which is the most important point :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting response topic: docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants