Skip to content

Update documentation to make it easier to start #1310

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

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

lfoppiano
Copy link
Collaborator

@lfoppiano lfoppiano commented Jul 7, 2025

This PR aims to make the documentation less scary for python and young developers 🐉

Goals:

  1. Provide an easy "getting started"
  2. Allow people to try on the cloud in advance
  3. For local deployment prioritise Docker over the native installation

@coveralls
Copy link

coveralls commented Jul 7, 2025

Coverage Status

coverage: 40.576%. remained the same
when pulling 36ee763 on improvement/better-simpler-documentation
into f6b522b on master.

@lfoppiano lfoppiano changed the title Update documentation Update documentation to make it easier to start Jul 8, 2025
@lfoppiano
Copy link
Collaborator Author

lfoppiano commented Jul 16, 2025

One comment is to streamline the docker image naming, which is pretty confusing.

We could use

  1. grobid/grobid:{version}-{full|crf}
  2. or we could use lfoppiano/grobid:{version}-{full|crf} which would be easier for me to maintain :-)

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