Skip to content

Refactor Doxygen INPUT organization for better documentation flow with appendices at end#9

Closed
Copilot wants to merge 4 commits intomainfrom
copilot/fix-8
Closed

Refactor Doxygen INPUT organization for better documentation flow with appendices at end#9
Copilot wants to merge 4 commits intomainfrom
copilot/fix-8

Conversation

Copy link
Copy Markdown

Copilot AI commented Aug 12, 2025

The NetCDF-C documentation was poorly organized due to Doxygen's "first-in, first-out" processing behavior, where files listed in the INPUT section appear in the generated documentation in the same order they are specified. This resulted in users seeing advanced internal documentation before basic installation guides, API reference mixed arbitrarily with tutorials, and appendices scattered throughout instead of appearing at the end.

Changes Made

Reorganized the INPUT section in docs/Doxyfile.in to follow a logical progression that guides users from basic concepts to advanced topics, with all appendices properly positioned at the end:

  1. Introduction & Overview - What is NetCDF, basic concepts (mainpage.dox, groups.dox)
  2. Getting Started - Installation, building, quickstart guides (building-with-cmake.md, install-fortran.md, etc.)
  3. User Guides - Tutorials and FAQ (tutorial.dox, FAQ.md)
  4. Core API Reference - Primary header files (netcdf.h, netcdf_mem.h, etc.)
  5. Advanced Topics - Specialized features (inmemory.md, quantize.md, byterange.md, auth.md, etc.)
  6. Developer Documentation - Internals and architecture (internal.md, inmeminternal.dox, etc.)
  7. Reference Materials - Release notes, specifications, credits
  8. Implementation - Source code examples and internal implementation
  9. Appendices - All documentation files containing appendix content:
    • cloud.md (Appendices A, B, C for S3 support)
    • dispatch.md (Appendices A, B for dispatch layer)
    • filters.md (Appendices A-I for filter mechanisms)
    • nczarr.md (Appendices A-E for Zarr format)
    • pluginpath.md (Appendix E.1 for plugin paths)

Impact

This reorganization addresses core usability issues where users would encounter:

  • Release notes before knowing what NetCDF is
  • Internal implementation details before learning how to install
  • Advanced cloud authentication before basic tutorials
  • Appendices scattered throughout the documentation instead of at the end

Now users follow a natural learning path: What is NetCDF?How do I build it?How do I use it?Advanced featuresReference materialsAppendices.

Validation

  • All 99 INPUT files verified to exist in the repository
  • Documentation generation tested successfully with Doxygen
  • Comparative testing confirms improved logical flow with proper appendix organization

This minimal change to a single configuration file significantly improves the organization and usability of the entire NetCDF-C documentation system.

Fixes #8.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copilot AI and others added 2 commits August 12, 2025 21:08
Co-authored-by: WardF <4324946+WardF@users.noreply.github.com>
Co-authored-by: WardF <4324946+WardF@users.noreply.github.com>
Copilot AI changed the title [WIP] Documentation needs to be refactored. Refactor Doxygen INPUT organization for better documentation flow Aug 12, 2025
Copilot AI requested a review from WardF August 12, 2025 21:10
@WardF
Copy link
Copy Markdown
Owner

WardF commented Aug 12, 2025

@copilot The Appendices should all appear at the end, in order.

Co-authored-by: WardF <4324946+WardF@users.noreply.github.com>
Copy link
Copy Markdown
Author

Copilot AI commented Aug 12, 2025

@copilot The Appendices should all appear at the end, in order.

Fixed in commit 04ca73a. Moved all files containing appendices to the end of the INPUT list in this order:

  • cloud.md (Appendices A, B, C)
  • dispatch.md (Appendices A, B)
  • filters.md (Appendices A-I)
  • nczarr.md (Appendices A-E)
  • pluginpath.md (Appendix E.1)

All appendices now appear at the end in logical order.

Copilot AI changed the title Refactor Doxygen INPUT organization for better documentation flow Refactor Doxygen INPUT organization for better documentation flow with appendices at end Aug 12, 2025
@WardF WardF closed this Aug 13, 2025
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.

Documentation needs to be refactored.

2 participants