Files
go-rst/CHECKLIST.md
2025-01-30 18:56:15 -05:00

2.0 KiB

RST Feature Implementation Checklist

Basic Document Structure

  • Headings/Sections
  • Paragraphs
  • Nesting/Hierarchy support
  • Basic content management
  • Document title/subtitle
  • Transitions (horizontal lines)

Text Styling

  • Strong (bold) text
  • Emphasis (italic) text
  • Interpreted text
  • Inline literals

Lists

  • Ordered lists
  • Unordered lists
  • List items
  • Definition lists
  • Field lists
  • Option lists
  • Hyperlinks (explicit)
  • Anonymous hyperlinks
  • Internal references
  • Footnotes
  • Citations

Code Blocks

  • Basic code blocks
  • Language specification
  • Line number support
  • Code block options
  • Line highlighting

Tables

  • Basic table structure
  • Headers
  • Rows
  • Grid tables
  • Simple tables
  • CSV tables

Directives

  • Basic directive support
  • Directive arguments
  • Raw content handling
  • Image directives
  • Figure directives
  • Include directives
  • Admonitions
  • Topic directives
  • Sidebar directives

Metadata

  • Basic metadata support
  • Key-value pairs
  • Document metadata
  • Role definitions

Missing Features

Document Components

  • Block quotes
  • Doctest blocks
  • Line blocks
  • Comments

Advanced Features

  • Substitutions
  • Roles
  • Math support
  • Custom roles
  • Raw input
  • Container directives

Specialized Elements

  • Tables of contents
  • Index entries
  • Bibliography
  • Glossary

Implementation Notes

The current implementation provides a solid foundation with:

  • A flexible node-based architecture
  • Strong type hierarchy
  • Clean interface definitions
  • Good support for basic RST features
  • Extensible structure for future additions

Development Status

  • Core Features: ~40% complete
  • Basic Text Processing: ~70% complete
  • Advanced Features: ~20% complete
  • Overall Completion: ~45%