Skip to content

Commit 5eada63

Browse files
committed
Update ROADMAP.md
1 parent 4710862 commit 5eada63

1 file changed

Lines changed: 0 additions & 73 deletions

File tree

ROADMAP.md

Lines changed: 0 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,6 @@
44

55
High-value features that build on existing infrastructure.
66

7-
### Author Attribution & Avatars
8-
9-
Display author information with circular GitHub-style avatars on authored pages.
10-
11-
- Author name and image from page YAML frontmatter (`author: {name, image, url}`)
12-
- Multiple author avatars displayed in a row
13-
- Circular avatar images (falls back to initials when no image)
14-
- Hover tooltip shows full author name
15-
- Author lookup from `great-docs.yml` `authors:` list for full metadata
16-
- Only shown on authored pages (user guide, blog, recipes) with explicit `author:` frontmatter
17-
- Auto-generated pages (reference, changelog) show timestamps only, no author
18-
- Optional `team_author:` config for a catch-all team attribution (e.g., "Great Tables Team")
19-
- `site.show_author: true/false` to enable/disable author display
20-
217
### Reading Time Estimate
228

239
Auto-calculate and display estimated reading time.
@@ -28,35 +14,6 @@ Auto-calculate and display estimated reading time.
2814
- Show/hide globally or per-page
2915
- Useful for user guide articles, tutorials, and blog posts
3016

31-
### Breadcrumb Navigation
32-
33-
Display navigation path above page content.
34-
35-
- Breadcrumb trail showing hierarchy (Home > User Guide > Configuration)
36-
- Clickable links to parent sections
37-
- Helps orientation in deep documentation structures
38-
- Hide per-page via frontmatter if desired
39-
- Responsive design for mobile
40-
41-
### Enhanced CLI Reference
42-
43-
API-reference-style rendering for CLI applications.
44-
45-
- **Click** (primary): Parse command/group decorators to extract structure
46-
- **Typer**: Leverage Click internals via Typer's underlying Click commands
47-
- **argparse**: Parse `ArgumentParser` definitions and subparsers
48-
- **Fire**: Introspect Python functions/classes exposed as CLI
49-
- **Extensible**: Plugin interface for additional CLI frameworks
50-
- Generate `.qmd` pages with prose sections for each command and subcommand
51-
- Render arguments, options, and flags in styled parameter tables (like API reference)
52-
- Include type annotations, defaults, and help text
53-
- Auto-generate usage examples from framework-specific example metadata
54-
- Cross-reference between subcommands and parent groups
55-
- Search integration: CLI commands indexed alongside API symbols
56-
- Support for command aliases and deprecated commands
57-
- Environment variable documentation
58-
- Alternative to raw `--help` output: richer formatting, navigation, and discoverability
59-
6017
### Docstring Coverage Report
6118

6219
Audit which public symbols have complete documentation.
@@ -156,36 +113,6 @@ Self-contained sites that work without an internet connection.
156113
- Bundled search index for offline queries
157114
- Optional asset inlining for single-file deployment
158115

159-
### Blog Support
160-
161-
First-class blogging integrated with documentation.
162-
163-
- Posts directory with date-based organization
164-
- Automatic archive and category index pages
165-
- Post excerpts with `<!-- more -->` separator
166-
- Author profiles with avatars and bios
167-
- Categories and tags per post
168-
- RSS feed generation
169-
- Reading time and publication date display
170-
- Pinned/featured posts
171-
- Pagination for post listings
172-
- Blog-only mode (documentation optional)
173-
174-
### MCP Server Documentation
175-
176-
Generate documentation for Model Context Protocol (MCP) server projects.
177-
178-
- Auto-discover tools, resources, and prompts from MCP server source code
179-
- Render tool schemas (input/output JSON Schema) in styled parameter tables
180-
- Document resource URI templates with examples
181-
- Display prompt templates with argument descriptions
182-
- Support for multiple transport types (stdio, SSE, streamable HTTP)
183-
- Cross-reference between tools and resources
184-
- "Try it" links or copy-able JSON-RPC examples for each tool
185-
- Server capability summary page (tools count, resources, prompts)
186-
- Configuration reference for server setup (env vars, auth, endpoints)
187-
- Compatible with Python (`mcp` SDK), TypeScript (`@modelcontextprotocol/sdk`), and other MCP implementations
188-
189116
### Instant Loading
190117

191118
SPA-like navigation without full page reloads.

0 commit comments

Comments
 (0)