Skip to content

Fix markdown formatting in README.md #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Kondamon wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix markdown formatting in README.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ The `CLAUDE.md` file is your primary context provider. Claude automatically load

Create `CLAUDE.md` in your project root:

```markdown
````markdown
# Project: [Your App Name]

## Quick Reference
Expand Down Expand Up @@ -227,13 +227,13 @@ When starting new features:
@import docs/PRD.md
@import docs/ARCHITECTURE.md
@import docs/ROADMAP.md
```
````

### Nested CLAUDE.md for Feature Directories

Create `.claude/CLAUDE.md` or `Features/[FeatureName]/CLAUDE.md`:

```markdown
````markdown
# [Feature Name] Module

## Purpose
Expand Down Expand Up @@ -265,7 +265,7 @@ final class ParentViewModel {

## Testing
Run tests: `mcp__xcodebuildmcp__swift_package_test`
```
````

---

Expand Down Expand Up @@ -356,7 +356,7 @@ docs/

### Feature Spec Template (`docs/specs/template.md`)

```markdown
````markdown
# Feature Specification: [Feature Name]

**Status**: Draft | In Review | Approved | In Progress | Complete
Expand Down Expand Up @@ -417,7 +417,7 @@ POST /api/v1/feature

## Open Questions
- [ ] Question 1?
```
````

### Task File Template (`docs/tasks/feature-tasks.md`)

Expand Down Expand Up @@ -1967,27 +1967,27 @@ MyiOSApp/
│ │ ├── session-start.sh
│ │ ├── post-swift-edit.sh
│ │ └── file-protection.sh
│ ├── settings.json # Team settings (committed)
│ └── settings.local.json # Personal settings (gitignored)
│ └── settings.sandbox.json # Sandbox mode template
│ ├── settings.json # Team settings (committed)
│ ├── settings.local.json # Personal settings (gitignored)
│ └── settings.sandbox.json # Sandbox mode template
├── .mcp.json # MCP server configuration
├── CLAUDE.md # Main project context
├── docs/
│ ├── PRD.md # Product Requirements Document
│ ├── ARCHITECTURE.md # Architecture decisions
│ ├── ROADMAP.md # Development roadmap
│ ├── specs/ # Feature specifications
│ ├── PRD.md # Product Requirements Document
│ ├── ARCHITECTURE.md # Architecture decisions
│ ├── ROADMAP.md # Development roadmap
│ ├── specs/ # Feature specifications
│ │ ├── template.md
│ │ ├── 001-authentication.md
│ │ └── 002-dashboard.md
│ └── tasks/ # Task breakdowns
│ └── tasks/ # Task breakdowns
│ └── authentication-tasks.md
├── MyApp/
│ ├── App/
│ │ └── MyAppApp.swift
│ ├── Features/
│ │ ├── Authentication/
│ │ │ ├── CLAUDE.md # Feature-specific context
│ │ │ ├── CLAUDE.md # Feature-specific context
│ │ │ ├── Views/
│ │ │ └── ViewModels/
│ │ └── Dashboard/
Expand All @@ -1999,7 +1999,7 @@ MyiOSApp/
├── MyAppTests/
├── MyAppUITests/
├── Package.swift # If using SPM
├── .swiftlint.yml # SwiftLint configuration
├── .swiftlint.yml # SwiftLint configuration
├── .swift-format # Swift-format configuration
└── .gitignore
```
Expand Down
Loading