Skip to content

Refactor current documentation #171

@John15321

Description

@John15321

Current issues

  1. Varying levels of detail
  2. E2E Testing: Clear instructions but requires familiarity with Azure resources and CLI and lacks context.
  3. Inconsistent Formatting: The structure and formatting style varies between documents.
  4. Missing Information:
    • Limited explanation of what azure-init actually does in practical terms
    • No clear "Getting Started" guide for new users
    • No troubleshooting section
    • Limited information about the architecture of the system
    • Audience Considerations: The documentation seems to target mostly developers already familiar with the project rather than new users.
  5. Directory Structure: The documentation is split between doc and docs directories, which could be confusing.
  6. Advanced Configuration: Good detailed explanation of configuration, but might be overwhelming for new users.

Metadata

Metadata

Assignees

Type

No type

Projects

Status

In Progress

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions