[Dev doc] Add overview and explain repository structure #1562
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
garrettmoon
approved these changes
Jun 26, 2019
docs/_docs/development/overview.md
Outdated
| - [Base](https://github.com/TextureGroup/Texture/tree/master/Source/Base): Helper and utility files used throughout the framework. | ||
| - [Debug](https://github.com/TextureGroup/Texture/tree/master/Source/Debug): Files used for debugging functionalities. | ||
| - [Details](https://github.com/TextureGroup/Texture/tree/master/Source/Details): Implementaion details of the framework that are exposed to end users. |
There was a problem hiding this comment.
Should this mention that the headers are exposed specifically?
docs/_docs/development/overview.md
Outdated
| - [Debug](https://github.com/TextureGroup/Texture/tree/master/Source/Debug): Files used for debugging functionalities. | ||
| - [Details](https://github.com/TextureGroup/Texture/tree/master/Source/Details): Implementaion details of the framework that are exposed to end users. | ||
| - [Layout](https://github.com/TextureGroup/Texture/tree/master/Source/Layout): Files related to the layout system, including layout-premitives types, layout specs and utility files for Yoga and IGListKit support. |
There was a problem hiding this comment.
layout-premitives -> layout-primitive
docs/_docs/development/overview.md
Outdated
| - [TextKit](https://github.com/TextureGroup/Texture/tree/master/Source/TextKit): All files related to TextKit that are used by ASTextNode. | ||
| - [tvOS](https://github.com/TextureGroup/Texture/tree/master/Source/tvOS): tvOS support. | ||
| - All other files in the [Source](https://github.com/TextureGroup/Texture/tree/master/Source) directory: Main files that are exposed to end users, including include important components such as nodes (e.g ASDisplayNode, ASButtonNode, ASImageNode, ASCollectionNode and ASTableNode), ASNavigationController, etc. |
There was a problem hiding this comment.
including include -> including
docs/_docs/development/overview.md
Outdated
| - [Tests](https://github.com/TextureGroup/Texture/tree/master/Tests): The framework's test suite, including unit, integration and snapshot test cases. | ||
| - [docs](https://github.com/TextureGroup/Texture/tree/master/docs): Texture documentation that powers [texturegroup.org](https://texturegroup.org/). | ||
| - [examples](https://github.com/TextureGroup/Texture/tree/master/examples): Sample projects on demonstrate how to use various features of the framework. |
There was a problem hiding this comment.
Sample projects on demonstrate -> Sample projects which demonstrate
mikezucc
approved these changes
Jun 27, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.