Skip to content

Create project structure #4

@edeandrea

Description

@edeandrea

We need to create a basic project skeleton. This is what I'm thinking for starters. We can always evolve it as needed.

.  # root will be the parent project - not sure we need a bom artifact yet
+-- .github
       +-- dependabot.yml
       +-- workflows
              +-- dependabot-automerge.yml
              # Other GH action workflows
+-- api
       # Java project - Code in here is part of the public api. Mostly interfaces/definitions. Separate artifact published to maven central.
       +-- src/main/java/ai/docling
              +-- api  
                     # Code/subpackages in here
+-- docs  
       # Antora documentation - we should theme it to be consistent with the rest of the Docling projects
+-- impl  
       # Java project (I'm not crazy about the name but its something we need), but this will be the reference implementation
       +-- src/main/java/ai/docling 
              # Code/subpackages in here
+-- testing  
       # Java project - Any testing-related code (i.e. testcontainers/etc), or any test resources . Separate artifact published to maven central
       +-- src/main/java/ai/docling
              +-- test  # Code/subpackages in here

@ThomasVitale @lordofthejars thoughts?

Also, any preference on using Maven vs Gradle? I don't have a preference.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions