Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
fix trees in static files section
  • Loading branch information
trevor-coleman authored May 22, 2024
1 parent 886dbab commit 10c5db3
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ docs/
├── part-one.md
├── part-two.md
└── _static_
└── image.png
└── image.png
```
During the documentation merge process, the orb will automatically move the contents of _static_ to the appropriate location in the target repository.
Expand All @@ -198,7 +198,7 @@ source-repo/
└── docs/
│ ├── part-one.md
│ └── part-two.md
└── _static_/
└── _static_/
└── image.png
```
Expand All @@ -211,7 +211,7 @@ ir-docs/
│ └── part-two.md
└── static/
└── <<project-name>>
└── image.png
└── image.png
```
By following this convention, you ensure that all static files and documents are correctly placed in the target repository, under docs/<<project-name>> for documents and static/<<project-name>> for static files.
Expand Down

0 comments on commit 10c5db3

Please sign in to comment.