Skip to content

Commit

Permalink
docs: update todo.md with new task categories and tags; add 'private/…
Browse files Browse the repository at this point in the history
…' to .gitignore
  • Loading branch information
shaneholloman committed Sep 24, 2024
1 parent 5b3c4f4 commit 35ed085
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 6 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
_github/
_output/
_mapped/
private/

# Byte-compiled / optimized / DLL files
__pycache__/
Expand Down
30 changes: 24 additions & 6 deletions notes/todo.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# CodeMapper TODO List

- [ ] Add these tasks to the github project board

## Core Functionality

(tag is `core`)

- [x] Implement direct repository URL analysis
- [ ] Expand Git hosting service support (GitLab, Bitbucket)
- [ ] Develop progress indicator for large repository processing
Expand All @@ -11,25 +15,39 @@
- [ ] AI-powered analysis
- [ ] Add option to update original repo with categories (for owners)

## File Outputs

(tag is `outputs`)

- [x] Generate `*_codemap.md` for file contents and directory structure
- [ ] Create separate `*_docmap.md` for documentation directories
- [ ] Add repository source information to output file header

## CodeMapper Service

(tag is `service`)

- [ ] Create a server version of CodeMapper with API
- [ ] Implement user authentication and authorization

## Documentation

(tag is `docs`)

- [x] Utilize changelog.md for version tracking
- [ ] Create separate `*_docmap.md` for documentation directories
- [ ] Add repository source information to output file header

## AI Integration

(tag is `ai`)

- [ ] Implement AI-generated alt text for images --option
- [ ] Implement AI-generated code summarization --option
- [ ] Explore base64 image encoding and embedding in output --option

## Output Formats

(tag is `outputs`)

- [x] Markdown (default)
- [ ] JSON
- [ ] YAML
Expand All @@ -38,17 +56,17 @@

## User Experience

(tag is `ux`)

- [ ] Develop comprehensive help command and menu
- [ ] Enhance Table of Contents generation
- [ ] Consider using `md_toc` library for robustness
- [ ] EPIC: Introduce Mermaid flow chart option for code execution flow visualization

## Developer Experience

(tag is `dx`)

- [x] Implement CI for linting
- [ ] Implement CI for automated testing
- [ ] Implement CI for PyPI package deployment

## File Handling

- [x] Generate `*_codemap.md` for file contents and directory structure

0 comments on commit 35ed085

Please sign in to comment.