Skip to content

✨ Proposal: Standardize Documentation Format Across Guides #155

@umarfarook2180

Description

@umarfarook2180

Hi maintainers,

While exploring the documentation for SW360, I noticed that there are some inconsistencies across the different .md files, especially in the Deployment and Legacy sections. For example:

  • Some files have a "Last updated" line, others do not
  • Heading levels (## vs ###) vary between guides
  • Internal links between related documents are missing in some places
  • Some filenames use inconsistent casing or versioning

I’d like to propose a standard documentation format that can be applied gradually across guides, covering:

  • Consistent heading structure
  • Adding "Last updated" metadata
  • Improving internal linking between docs
  • Filename conventions

Let me know if you'd like a draft format or if this is something you'd be open to! I’d be happy to help implement these improvements.

Thanks!

Metadata

Metadata

Assignees

No one assigned

    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