Opened 9 years ago
Closed 5 years ago
#1091 closed enhancement (wontfix)
Document rasdaman top-level directories
| Reported by: | Dimitar Misev | Owned by: | Dimitar Misev |
|---|---|---|---|
| Priority: | major | Milestone: | Future |
| Component: | wiki | Version: | development |
| Keywords: | Cc: | Peter Baumann, Alex Toader, Vlad Merticariu, George Merticariu, Alex Dumitru | |
| Complexity: | Medium |
Description
We need to clearly document what the role of each directory with code in rasdaman is and how it relates with the rest. There are many directories and it is often confusing and intimidating for newcomers without some documentation.
Is there some usual standard way to do this? In Java we'd have package.html or so; I'm not sure about autotools managed projects.
How about putting a README or similar file in each directory for this purpose? With a simple script we can collect these descriptions and generate a wiki page content for overview.
Change History (5)
comment:1 by , 9 years ago
comment:2 by , 9 years ago
This looks like a good template: https://www.rosettacommons.org/manuals/rosetta3.2_user_guide/template_index_page.html
comment:3 by , 8 years ago
| Milestone: | 9.2 → 9.4 |
|---|
comment:4 by , 8 years ago
| Milestone: | 9.4 → Future |
|---|
comment:5 by , 5 years ago
| Resolution: | → wontfix |
|---|---|
| Status: | new → closed |
Note:
See TracTickets
for help on using tickets.
Actually we are using doxygen if —with-docs is specified, so it would be best to document directories in a way compliant with doxygen.