Skip to content

Commit e8906cb

Browse files
docs: updated readme to use includes folder as starting directory (#918)
1 parent 0b83401 commit e8906cb

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,16 @@ These are the markdown sources for all of the [Parse SDK guides](https://parse-c
1111

1212
## Repository Structure
1313

14-
The guides are organized by platform. Each platform directory contains a set of markdown files, one for each main section in the guide.
14+
The guides are organized by platform inside the _includes directory. Each platform directory contains a set of markdown files, one for each main section in the guide.
1515

1616
.
17-
├── {platform}
18-
│ └── {section}
19-
└── common
20-
└── {section}
17+
└── _includes
18+
├── {platform}
19+
│ └── {section}
20+
└── common
21+
└── {section}
2122

22-
For example, `/ios/` contains all of sections for the iOS guide. There is also a `common` folder that contains content that is shared amongst all of the guides. It helps us avoid duplicating content unnecessarily.
23+
For example, `/_includes/ios/` contains all of sections for the iOS guide. There is also a `/_includes/common` folder that contains content that is shared amongst all of the guides. It helps us avoid duplicating content unnecessarily.
2324

2425
## Can I Access The Docs Offline?
2526

0 commit comments

Comments
 (0)