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.md needs an update #316

Closed
geoand opened this issue Dec 16, 2018 · 5 comments
Closed

README.md needs an update #316

geoand opened this issue Dec 16, 2018 · 5 comments

Comments

@geoand
Copy link
Contributor

geoand commented Dec 16, 2018

The Architecture Overview in the README mentions the ResourceProcessor which no longer exists.

@cescoffier
Copy link
Member

cescoffier commented Dec 16, 2018 via email

@geoand
Copy link
Contributor Author

geoand commented Dec 16, 2018

Yeah I noticed that looking at the git history :P

@dmlloyd
Copy link
Member

dmlloyd commented Dec 16, 2018

Do we think it's more important to reflect the current state of the code, or the final architecture? If the former, we could spend a lot of time updating outdated docs. OTOH the latter won't be totally accurate (yet).

@dmlloyd
Copy link
Member

dmlloyd commented Dec 16, 2018

Maybe it should be an overview of the final architecture with notes about things that are temporarily different or not implemented yet.

@gsmet gsmet changed the title Architectural Overview in README is outdated README.md needs an update Feb 6, 2019
@gsmet
Copy link
Member

gsmet commented Feb 6, 2019

Maybe we should try to be more concise and avoid pointing to actual class names.

Having a general overview should be enough. And maybe point to the root of a very simple extension that we could give as an example.

Moving that to first public release as we don't want the release to be done with outdated information in the README.

stuartwdouglas referenced this issue in stuartwdouglas/quarkus-old Feb 13, 2019
Most of this is in outher guides now, and does not make sense to be in the README
stuartwdouglas added a commit that referenced this issue Feb 13, 2019
Fixes #316 remove a lot of out of date info from the readme
@cescoffier cescoffier added this to the 0.9.0 milestone Feb 14, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants