diff --git a/README.md b/README.md index e6f12508..c37fc168 100644 --- a/README.md +++ b/README.md @@ -50,4 +50,4 @@ The new version is not deployed yet. ### Documentation index -See `documentation/README.md` for the full documentation tree (includes reviewer notes, FAQ, and a complete list of docs). +See [`documentation/README.md`](documentation/README.md) for the full documentation tree (includes reviewer notes, FAQ, and a complete list of docs). diff --git a/documentation/README.md b/documentation/README.md index 54d6f90b..b5317a34 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -4,92 +4,92 @@ This folder is the canonical home for repository documentation. ## Quick Links -- Getting started: `README.md` (repo root) -- Contributing: `documentation/contributing.md` -- DevOps / running locally: `documentation/devops/setup.md`, `documentation/devops/commands.md` -- Testing overview: `documentation/testing.md` -- Frontend overview: `documentation/frontend/frontend.md` -- Backend notes: `documentation/backend/` -- Entity docs: `documentation/entities/` +- Getting started: [`README.md`](../README.md) (repo root) +- Contributing: [`contributing.md`](contributing.md) +- DevOps / running locally: [`devops/setup.md`](devops/setup.md), [`devops/commands.md`](devops/commands.md) +- Testing overview: [`testing.md`](testing.md) +- Frontend overview: [`frontend/frontend.md`](frontend/frontend.md) +- Backend notes: [`backend/`](backend/) +- Entity docs: [`entities/`](entities/) ## Reviewer Notes -- `documentation/reviewer-notes.md` +- [`reviewer-notes.md`](reviewer-notes.md) ## FAQ / Troubleshooting -- `documentation/computer_specific_troubleshooting.md` -- `documentation/lint-tsc-failure-analysis.md` -- `documentation/faq/technical-questions.md` +- [`computer_specific_troubleshooting.md`](computer_specific_troubleshooting.md) +- [`lint-tsc-failure-analysis.md`](lint-tsc-failure-analysis.md) +- [`faq/technical-questions.md`](faq/technical-questions.md) ## Full Document List (no orphans) ### Root-level docs -- `README.md` -- `OCCURRENCE_UI_RENAME_PLAN.md` +- [`README.md`](../README.md) +- [`OCCURRENCE_UI_RENAME_PLAN.md`](../OCCURRENCE_UI_RENAME_PLAN.md) ### documentation/ -- `documentation/README.md` -- `documentation/CHANGELOG.md` -- `documentation/api/time-units.md` -- `documentation/architecture.md` -- `documentation/backend/cross_search_export.md` -- `documentation/backend/rate_limiting_for_emails.md` -- `documentation/backend/server_side_pagination.md` -- `documentation/backend/species_synonym_creation_flow.md` -- `documentation/class_diagram.md` -- `documentation/codex_planning_prompt.md` -- `documentation/coding_prompt_template_fullstack.md` -- `documentation/computer_specific_troubleshooting.md` -- `documentation/contributing.md` -- `documentation/cypress-performance-optimization.md` -- `documentation/definition_of_done.md` -- `documentation/devops/commands.md` -- `documentation/devops/database.md` -- `documentation/devops/docker.md` -- `documentation/devops/github_actions.md` -- `documentation/devops/openshift.md` -- `documentation/devops/setup.md` -- `documentation/devops/write-guard.md` -- `documentation/entities/locality.md` -- `documentation/entities/occurrence.md` -- `documentation/entities/project.md` -- `documentation/entities/reference.md` -- `documentation/entities/reference_types.md` -- `documentation/entities/region.md` -- `documentation/entities/species.md` -- `documentation/entities/time_bound.md` -- `documentation/entities/time_unit.md` -- `documentation/faq/technical-questions.md` -- `documentation/frontend/components/EditableTable.md` -- `documentation/frontend/components/SimpleTable.md` -- `documentation/frontend/components/TableView.md` -- `documentation/frontend/components/editingComponents/BasisForAgeSelection.md` -- `documentation/frontend/components/editingComponents/DropdownSelector.md` -- `documentation/frontend/components/editingComponents/DropdownSelectorWithSearch.md` -- `documentation/frontend/components/editingComponents/EditableTextField.md` -- `documentation/frontend/components/editingComponents/FieldWithTableSelection.md` -- `documentation/frontend/components/editingComponents/FormTextField.md` -- `documentation/frontend/components/editingComponents/RadioSelector.md` -- `documentation/frontend/components/editingComponents/TimeBoundSelection.md` -- `documentation/frontend/components/maps/CoordinateSelectionMap.md` -- `documentation/frontend/components/maps/LocalitiesMap.md` -- `documentation/frontend/components/maps/README.md` -- `documentation/frontend/components/maps/SingleLocalityMap.md` -- `documentation/frontend/frontend.md` -- `documentation/frontend/routing.md` -- `documentation/frontend/tables.md` -- `documentation/functionality/cascading_effects.md` -- `documentation/functionality/changelog.md` -- `documentation/functionality/put_requests_for_db_entries.md` -- `documentation/functionality/species_merge.md` -- `documentation/functionality/species_taxonomy_checks.md` -- `documentation/functionality/table_column_visibility.md` -- `documentation/lint-tsc-failure-analysis.md` -- `documentation/reference-validation-messages.md` -- `documentation/reviewer-notes.md` -- `documentation/testing.md` -- `documentation/update-log-navigation-flow.md` -- `documentation/user_rights.md` +- [`README.md`](README.md) +- [`CHANGELOG.md`](CHANGELOG.md) +- [`api/time-units.md`](api/time-units.md) +- [`architecture.md`](architecture.md) +- [`backend/cross_search_export.md`](backend/cross_search_export.md) +- [`backend/rate_limiting_for_emails.md`](backend/rate_limiting_for_emails.md) +- [`backend/server_side_pagination.md`](backend/server_side_pagination.md) +- [`backend/species_synonym_creation_flow.md`](backend/species_synonym_creation_flow.md) +- [`class_diagram.md`](class_diagram.md) +- [`codex_planning_prompt.md`](codex_planning_prompt.md) +- [`coding_prompt_template_fullstack.md`](coding_prompt_template_fullstack.md) +- [`computer_specific_troubleshooting.md`](computer_specific_troubleshooting.md) +- [`contributing.md`](contributing.md) +- [`cypress-performance-optimization.md`](cypress-performance-optimization.md) +- [`definition_of_done.md`](definition_of_done.md) +- [`devops/commands.md`](devops/commands.md) +- [`devops/database.md`](devops/database.md) +- [`devops/docker.md`](devops/docker.md) +- [`devops/github_actions.md`](devops/github_actions.md) +- [`devops/openshift.md`](devops/openshift.md) +- [`devops/setup.md`](devops/setup.md) +- [`devops/write-guard.md`](devops/write-guard.md) +- [`entities/locality.md`](entities/locality.md) +- [`entities/occurrence.md`](entities/occurrence.md) +- [`entities/project.md`](entities/project.md) +- [`entities/reference.md`](entities/reference.md) +- [`entities/reference_types.md`](entities/reference_types.md) +- [`entities/region.md`](entities/region.md) +- [`entities/species.md`](entities/species.md) +- [`entities/time_bound.md`](entities/time_bound.md) +- [`entities/time_unit.md`](entities/time_unit.md) +- [`faq/technical-questions.md`](faq/technical-questions.md) +- [`frontend/components/EditableTable.md`](frontend/components/EditableTable.md) +- [`frontend/components/SimpleTable.md`](frontend/components/SimpleTable.md) +- [`frontend/components/TableView.md`](frontend/components/TableView.md) +- [`frontend/components/editingComponents/BasisForAgeSelection.md`](frontend/components/editingComponents/BasisForAgeSelection.md) +- [`frontend/components/editingComponents/DropdownSelector.md`](frontend/components/editingComponents/DropdownSelector.md) +- [`frontend/components/editingComponents/DropdownSelectorWithSearch.md`](frontend/components/editingComponents/DropdownSelectorWithSearch.md) +- [`frontend/components/editingComponents/EditableTextField.md`](frontend/components/editingComponents/EditableTextField.md) +- [`frontend/components/editingComponents/FieldWithTableSelection.md`](frontend/components/editingComponents/FieldWithTableSelection.md) +- [`frontend/components/editingComponents/FormTextField.md`](frontend/components/editingComponents/FormTextField.md) +- [`frontend/components/editingComponents/RadioSelector.md`](frontend/components/editingComponents/RadioSelector.md) +- [`frontend/components/editingComponents/TimeBoundSelection.md`](frontend/components/editingComponents/TimeBoundSelection.md) +- [`frontend/components/maps/CoordinateSelectionMap.md`](frontend/components/maps/CoordinateSelectionMap.md) +- [`frontend/components/maps/LocalitiesMap.md`](frontend/components/maps/LocalitiesMap.md) +- [`frontend/components/maps/README.md`](frontend/components/maps/README.md) +- [`frontend/components/maps/SingleLocalityMap.md`](frontend/components/maps/SingleLocalityMap.md) +- [`frontend/frontend.md`](frontend/frontend.md) +- [`frontend/routing.md`](frontend/routing.md) +- [`frontend/tables.md`](frontend/tables.md) +- [`functionality/cascading_effects.md`](functionality/cascading_effects.md) +- [`functionality/changelog.md`](functionality/changelog.md) +- [`functionality/put_requests_for_db_entries.md`](functionality/put_requests_for_db_entries.md) +- [`functionality/species_merge.md`](functionality/species_merge.md) +- [`functionality/species_taxonomy_checks.md`](functionality/species_taxonomy_checks.md) +- [`functionality/table_column_visibility.md`](functionality/table_column_visibility.md) +- [`lint-tsc-failure-analysis.md`](lint-tsc-failure-analysis.md) +- [`reference-validation-messages.md`](reference-validation-messages.md) +- [`reviewer-notes.md`](reviewer-notes.md) +- [`testing.md`](testing.md) +- [`update-log-navigation-flow.md`](update-log-navigation-flow.md) +- [`user_rights.md`](user_rights.md)