Skip to content

Add namespace documentation for all Terminal.Gui.Editor namespaces #230

@tig

Description

@tig

Problem

The Terminal.Gui.Editor namespaces lack namespace-level XML documentation that provides an overview of each namespace's purpose and contents.

Expected

Each Terminal.Gui.Editor.* namespace should have namespace docs (via a NamespaceDoc class or equivalent mechanism) similar to how the Terminal.Gui library documents its namespaces. These show up in the docfx-generated API reference as the namespace summary.

These docs should leverage what's already written in README.md.

The main Editor namespace should show the Terminal.Gui.Editor repo's README hero.gif.

Reference

See how Terminal.Gui does it — each namespace has a summary that appears in the API docs TOC and namespace landing pages.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions