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

Document the structure of the project #923

Open
bchapuis opened this issue Jan 24, 2025 · 3 comments
Open

Document the structure of the project #923

bchapuis opened this issue Jan 24, 2025 · 3 comments
Labels
documentation Documentation related stuff

Comments

@bchapuis
Copy link
Member

The documentation contains TODOs that have not been completed.
https://baremaps.apache.org/documentation/developer-manual/project-structure/

I wouldn't go into much details as the structure and the modules tend to evolve, but a high level description may be beneficial. For instance, we could give a broad description for:

  • baremaps-core,
  • baremaps-cli,
  • why we have other submodules for codecs (baremaps-openstreetmap, baremaps-pmtiles, etc.).

As said, I wouldn't go into the details as the structure evolves, the intend should be to give pointers to new commers.

@YongGoose
Copy link

I think adding the documentation label would be a good idea :)

@bchapuis bchapuis added the documentation Documentation related stuff label Jan 24, 2025
@bchapuis
Copy link
Member Author

Yes, I also forgot to mention that it may be easier to maintain the developper's documentation directly in the main repository instead of the web site. A low hanging fruit, may be to remove this section from the website and to move the exiting documentations in README.md files directly into submodules.

@YongGoose
Copy link

A low hanging fruit, may be to remove this section from the website and to move the exiting documentations in README.md files directly into submodules.

Sounds Great 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation related stuff
Projects
None yet
Development

No branches or pull requests

2 participants