From f6ee699ec67b8f135def8fd767d9c10c8592c018 Mon Sep 17 00:00:00 2001 From: Huy Nguyen Date: Tue, 25 Jun 2019 12:49:15 -0700 Subject: [PATCH 1/2] Add overview and explain repository structure --- docs/_docs/development/overview.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/docs/_docs/development/overview.md b/docs/_docs/development/overview.md index 531fefe95..dbcdcb55c 100644 --- a/docs/_docs/development/overview.md +++ b/docs/_docs/development/overview.md @@ -1,7 +1,29 @@ --- -title: Overview +title: Overview and Structure layout: docs permalink: /development/overview.html --- -

👷👷‍♀️Under construction…

\ No newline at end of file +# Framework dependencies: + +At its [core](https://github.com/TextureGroup/Texture/blob/master/Texture.podspec#L18), Texture doesn't depend on any non-system frameworks or libraries. Functionalities such as image downloading and caching, video, map and photo assets supports are considered add-ons and extensible by end-users. [By default](https://github.com/TextureGroup/Texture/blob/master/Texture.podspec#L90) Texture includes first-class support for image downloading and caching by integrating [PINRemoteImage](https://github.com/TextureGroup/Texture/blob/master/Texture.podspec#L41) as well as default implementations for other functionalities mentioned above. + +# Repository structure + +Here are the main directories within the repository: +- [Source](https://github.com/TextureGroup/Texture/tree/master/Source): All source code of the framework resides here + - [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. + - [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. + - [Private](https://github.com/TextureGroup/Texture/tree/master/Source/Private): Framework-private files that are not exposed to end users, including implementation details, private data structures and helpers. + - [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. +- [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. +- [examples-extra](https://github.com/TextureGroup/Texture/tree/master/examples_extra): More sample projects. +- All other files in the root directory: Build, CI, git, CocoaPods and Carthage configuration files. + +To learn more about main classes and components within the framework, please read other documents under "Development" category. From 032cb454caac7bdb0220355157af0fad9acbea62 Mon Sep 17 00:00:00 2001 From: Huy Nguyen Date: Thu, 27 Jun 2019 10:38:45 -0700 Subject: [PATCH 2/2] Address Garrett's comments --- docs/_docs/development/overview.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/_docs/development/overview.md b/docs/_docs/development/overview.md index dbcdcb55c..315f8203e 100644 --- a/docs/_docs/development/overview.md +++ b/docs/_docs/development/overview.md @@ -14,15 +14,15 @@ Here are the main directories within the repository: - [Source](https://github.com/TextureGroup/Texture/tree/master/Source): All source code of the framework resides here - [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. - - [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. + - [Details](https://github.com/TextureGroup/Texture/tree/master/Source/Details): Implementaion details of the framework. + - [Layout](https://github.com/TextureGroup/Texture/tree/master/Source/Layout): Files related to the layout system, including layout-premitive types, layout specs and utility files for Yoga and IGListKit support. - [Private](https://github.com/TextureGroup/Texture/tree/master/Source/Private): Framework-private files that are not exposed to end users, including implementation details, private data structures and helpers. - [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. + - All other files in the [Source](https://github.com/TextureGroup/Texture/tree/master/Source) directory: Main files, including important components such as nodes (e.g ASDisplayNode, ASButtonNode, ASImageNode, ASCollectionNode and ASTableNode), ASNavigationController, etc. - [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. +- [examples](https://github.com/TextureGroup/Texture/tree/master/examples): Sample projects which demonstrate how to use various features of the framework. - [examples-extra](https://github.com/TextureGroup/Texture/tree/master/examples_extra): More sample projects. - All other files in the root directory: Build, CI, git, CocoaPods and Carthage configuration files.