Browse Source

fix broken docs links (#4278)

Raja Panidepu 6 years ago
parent
commit
a64920fef2
1 changed files with 30 additions and 30 deletions
  1. 30
    30
      docs/README.md

+ 30
- 30
docs/README.md View File

14
 - [v2 Roadmap](#v2-roadmap)
14
 - [v2 Roadmap](#v2-roadmap)
15
 - [v1 vs v2 feature comparison](#v1-vs-v2-feature-comparison)
15
 - [v1 vs v2 feature comparison](#v1-vs-v2-feature-comparison)
16
 - [Documentation](https://wix.github.io/react-native-navigation/v2/)
16
 - [Documentation](https://wix.github.io/react-native-navigation/v2/)
17
-- [Contributing](/docs/WorkingLocally.md)
17
+- [Contributing](/docs/docs/WorkingLocally.md)
18
 
18
 
19
 ## Why Rebuild react-native-navigation?
19
 ## Why Rebuild react-native-navigation?
20
 
20
 
61
 | sideMenu             |    ✅  |    ✅ |
61
 | sideMenu             |    ✅  |    ✅ |
62
 | tabs            |    ✅  |    ✅ |
62
 | tabs            |    ✅  |    ✅ |
63
 | External Component       |   ✅  |   ✅ |
63
 | External Component       |   ✅  |   ✅ |
64
-| splitView           |   ✅   |   [Contribute](/docs/WorkingLocally.md) |
64
+| splitView           |   ✅   |   [Contribute](/docs/docs/WorkingLocally.md) |
65
 
65
 
66
 ### Screen API
66
 ### Screen API
67
 
67
 
93
 | buttonColor         |    ✅      |✅|
93
 | buttonColor         |    ✅      |✅|
94
 | hidden             |   ✅      |     ✅|
94
 | hidden             |   ✅      |     ✅|
95
 | hideOnScroll         |  ✅    |✅|
95
 | hideOnScroll         |  ✅    |✅|
96
-| translucent         |   ✅     |     [Contribute](/docs/WorkingLocally.md)        |
97
-| transparent         |  ✅        |     [Contribute](/docs/WorkingLocally.md)        |
98
-| noBorder             |    ✅     |     [Contribute](/docs/WorkingLocally.md)        |
96
+| translucent         |   ✅     |     [Contribute](/docs/docs/WorkingLocally.md)        |
97
+| transparent         |  ✅        |     [Contribute](/docs/docs/WorkingLocally.md)        |
98
+| noBorder             |    ✅     |     [Contribute](/docs/docs/WorkingLocally.md)        |
99
 | drawUnder         |    ✅     |✅|
99
 | drawUnder         |    ✅     |✅|
100
-| blur               |    ✅     |      [Contribute](/docs/WorkingLocally.md)       |
100
+| blur               |    ✅     |      [Contribute](/docs/docs/WorkingLocally.md)       |
101
 | custom component          |✅     |✅|
101
 | custom component          |✅     |✅|
102
 | background component          |✅     |✅|
102
 | background component          |✅     |✅|
103
 | background clipToBounds      |    ✅     |     /iOS Specific       |
103
 | background clipToBounds      |    ✅     |     /iOS Specific       |
125
 
125
 
126
 |       statusBar        | iOS  | Android |
126
 |       statusBar        | iOS  | Android |
127
 |--------------------|:----:|:-----:|
127
 |--------------------|:----:|:-----:|
128
-| textColorScheme    |✅|[Contribute](/docs/WorkingLocally.md) |
128
+| textColorScheme    |✅|[Contribute](/docs/docs/WorkingLocally.md) |
129
 | textColorSchemeSingleScreen   |✅|     / iOS specific      |
129
 | textColorSchemeSingleScreen   |✅|     / iOS specific      |
130
-| blur             |    ✅     |      [Contribute](/docs/WorkingLocally.md)       |
131
-| hideWithTopBar          |   ✅     |     [Contribute](/docs/WorkingLocally.md)       |
132
-| hidden         |    ✅       |     [Contribute](/docs/WorkingLocally.md)      |
130
+| blur             |    ✅     |      [Contribute](/docs/docs/WorkingLocally.md)       |
131
+| hideWithTopBar          |   ✅     |     [Contribute](/docs/docs/WorkingLocally.md)       |
132
+| hidden         |    ✅       |     [Contribute](/docs/docs/WorkingLocally.md)      |
133
 
133
 
134
 |       other        | iOS  | Android |
134
 |       other        | iOS  | Android |
135
 |--------------------|:----:|:-----:|
135
 |--------------------|:----:|:-----:|
136
 | screenBackgroundColor        |   ✅     | ✅ |
136
 | screenBackgroundColor        |   ✅     | ✅ |
137
 | orientation       |    ✅     |✅|
137
 | orientation       |    ✅     |✅|
138
 | disabledBackGesture        |    ✅     |    / iOS specific     |
138
 | disabledBackGesture        |    ✅     |    / iOS specific     |
139
-| screenBackgroundImageName        |   ✅      |    [Contribute](/docs/WorkingLocally.md)        |
140
-| rootBackgroundImageName              |    ✅     |    [Contribute](/docs/WorkingLocally.md)       |
139
+| screenBackgroundImageName        |   ✅      |    [Contribute](/docs/docs/WorkingLocally.md)        |
140
+| rootBackgroundImageName              |    ✅     |    [Contribute](/docs/docs/WorkingLocally.md)       |
141
 | sideMenuVisible          |      ✅   |✅|
141
 | sideMenuVisible          |      ✅   |✅|
142
 
142
 
143
 
143
 
162
 | resetTo             |   ✅     |    ✅        |	✅|
162
 | resetTo             |   ✅     |    ✅        |	✅|
163
 | dismissModal        |   ✅     |     ✅       |	✅|
163
 | dismissModal        |   ✅     |     ✅       |	✅|
164
 | dismissAllModals    |   ✅     |      ✅      |	✅|
164
 | dismissAllModals    |   ✅     |      ✅      |	✅|
165
-| showContextualMenu      |   ✅     |     / Android specific       |[Contribute](/docs/WorkingLocally.md) |
166
-| dismissContextualMenu      |   ✅     |   / Androic specific        |[Contribute](/docs/WorkingLocally.md)  |
165
+| showContextualMenu      |   ✅     |     / Android specific       |[Contribute](/docs/docs/WorkingLocally.md) |
166
+| dismissContextualMenu      |   ✅     |   / Androic specific        |[Contribute](/docs/docs/WorkingLocally.md)  |
167
 | showFab      |   ✅     |    / Android specific     |✅|
167
 | showFab      |   ✅     |    / Android specific     |✅|
168
 | dismissFab      |   ✅     |    / Android specific       |✅|
168
 | dismissFab      |   ✅     |    / Android specific       |✅|
169
-| showSnackBar     |   ✅     |     / Android specific    |   [Contribute](/docs/WorkingLocally.md) |
170
-| dismissSnackBar     |   ✅     |    / Android specific      |  [Contribute](/docs/WorkingLocally.md) |
169
+| showSnackBar     |   ✅     |     / Android specific    |   [Contribute](/docs/docs/WorkingLocally.md) |
170
+| dismissSnackBar     |   ✅     |    / Android specific      |  [Contribute](/docs/docs/WorkingLocally.md) |
171
 | showLightBox        |   ✅     |:x:      |:x:  |
171
 | showLightBox        |   ✅     |:x:      |:x:  |
172
 | dismissLightBox     |   ✅     |:x:|:x: |
172
 | dismissLightBox     |   ✅     |:x:|:x: |
173
 | showOverlay|:x:|✅|✅|
173
 | showOverlay|:x:|✅|✅|
174
 | dismissOverlay|:x:|✅|✅|
174
 | dismissOverlay|:x:|✅|✅|
175
-| handleDeepLink      |   ✅     |       [Contribute](/docs/WorkingLocally.md)       | [Contribute](/docs/WorkingLocally.md) |
175
+| handleDeepLink      |   ✅     |       [Contribute](/docs/docs/WorkingLocally.md)       | [Contribute](/docs/docs/WorkingLocally.md) |
176
 | Screen Visibility   |   ✅     |       ✅     |✅|
176
 | Screen Visibility   |   ✅     |       ✅     |✅|
177
 
177
 
178
 ### Styles
178
 ### Styles
188
 | topBarButtonColor     |  ✅     |    ✅      |✅| Wix|
188
 | topBarButtonColor     |  ✅     |    ✅      |✅| Wix|
189
 | topBarHidden          |   ✅    |   ✅      |     ✅        | Wix|
189
 | topBarHidden          |   ✅    |   ✅      |     ✅        | Wix|
190
 | topBarHideOnScroll    |  ✅     |  ✅    |✅| Wix|
190
 | topBarHideOnScroll    |  ✅     |  ✅    |✅| Wix|
191
-| topBarTranslucent     |  ✅     |   ✅     |     [Contribute](/docs/WorkingLocally.md)        | Wix|
192
-| topBarTransparent     | ✅      |✅|     [Contribute](/docs/WorkingLocally.md)        |
193
-| topBarNoBorder        |  ✅     |    ✅     |     [Contribute](/docs/WorkingLocally.md)        |  @gtchance|
191
+| topBarTranslucent     |  ✅     |   ✅     |     [Contribute](/docs/docs/WorkingLocally.md)        | Wix|
192
+| topBarTransparent     | ✅      |✅|     [Contribute](/docs/docs/WorkingLocally.md)        |
193
+| topBarNoBorder        |  ✅     |    ✅     |     [Contribute](/docs/docs/WorkingLocally.md)        |  @gtchance|
194
 | drawUnderTabBar       |  ✅     |    ✅     |✅| |
194
 | drawUnderTabBar       |  ✅     |    ✅     |✅| |
195
 | drawUnderTopBar       |  ✅     |    ✅     |✅||
195
 | drawUnderTopBar       |  ✅     |    ✅     |✅||
196
-| statusBarBlur         |  ✅     |    ✅     |      [Contribute](/docs/WorkingLocally.md)       | @gtchance|
197
-| topBarBlur            | ✅      |    ✅     |      [Contribute](/docs/WorkingLocally.md)       | @gtchance|
196
+| statusBarBlur         |  ✅     |    ✅     |      [Contribute](/docs/docs/WorkingLocally.md)       | @gtchance|
197
+| topBarBlur            | ✅      |    ✅     |      [Contribute](/docs/docs/WorkingLocally.md)       | @gtchance|
198
 | tabBarHidden  |   ✅  |   ✅     |✅| @gtchance|
198
 | tabBarHidden  |   ✅  |   ✅     |✅| @gtchance|
199
 | statusBarTextColorScheme |  ✅   |✅|      / iOS specific    |
199
 | statusBarTextColorScheme |  ✅   |✅|      / iOS specific    |
200
 | statusBarTextColorSchemeSingleScreen|  ✅   |✅|     / iOS specific      |
200
 | statusBarTextColorSchemeSingleScreen|  ✅   |✅|     / iOS specific      |
201
-| topBarSubtitleColor          |  ✅   |✅|      [Contribute](/docs/WorkingLocally.md)      |
202
-| topBarSubtitleFontFamily    |   ✅  |✅|     [Contribute](/docs/WorkingLocally.md)       |
203
-| screenBackgroundColor     | ✅    |   ✅     |     [Contribute](/docs/WorkingLocally.md)       |  Wix|
201
+| topBarSubtitleColor          |  ✅   |✅|      [Contribute](/docs/docs/WorkingLocally.md)      |
202
+| topBarSubtitleFontFamily    |   ✅  |✅|     [Contribute](/docs/docs/WorkingLocally.md)       |
203
+| screenBackgroundColor     | ✅    |   ✅     |     [Contribute](/docs/docs/WorkingLocally.md)       |  Wix|
204
 | orientation     |  ✅   |    ✅     |✅| Wix|
204
 | orientation     |  ✅   |    ✅     |✅| Wix|
205
-| statusBarHideWithTopBar        |  ✅   |   ✅     |     [Contribute](/docs/WorkingLocally.md)       | @gtchance|
205
+| statusBarHideWithTopBar        |  ✅   |   ✅     |     [Contribute](/docs/docs/WorkingLocally.md)       | @gtchance|
206
 | statusBarHidden       |  ✅   |    ✅       |     ✅      | WIX |
206
 | statusBarHidden       |  ✅   |    ✅       |     ✅      | WIX |
207
 | disabledBackGesture       |   ✅  |   ✅  |    / iOS specific     |
207
 | disabledBackGesture       |   ✅  |   ✅  |    / iOS specific     |
208
-| screenBackgroundImageName         |   ✅  |   ✅      |    [Contribute](/docs/WorkingLocally.md)        |
209
-| rootBackgroundImageName            |  ✅   |    ✅     |    [Contribute](/docs/WorkingLocally.md)       |
208
+| screenBackgroundImageName         |   ✅  |   ✅      |    [Contribute](/docs/docs/WorkingLocally.md)        |
209
+| rootBackgroundImageName            |  ✅   |    ✅     |    [Contribute](/docs/docs/WorkingLocally.md)       |
210
 | setButtons          |   ✅     |    ✅    |✅| @Johan-dutoit|
210
 | setButtons          |   ✅     |    ✅    |✅| @Johan-dutoit|
211
 | title            |   ✅     |✅|    ✅| Wix|
211
 | title            |   ✅     |✅|    ✅| Wix|
212
 | toggleDrawer        |   ✅     |       ✅    |✅|
212
 | toggleDrawer        |   ✅     |       ✅    |✅|
213
 | setTabBadge         |    ✅    |       ✅    |✅| Wix|
213
 | setTabBadge         |    ✅    |       ✅    |✅| Wix|
214
 | switchToTab         |    ✅    |       ✅   |✅|
214
 | switchToTab         |    ✅    |       ✅   |✅|
215
 | topBar react component        |   ✅     |✅|✅|
215
 | topBar react component        |   ✅     |✅|✅|
216
-|Shared Element Transition|     :x:  |✅| [Contribute](/docs/WorkingLocally.md)|
217
-| splitViewScreen       |     :x:  |    ✅      | [Contribute](/docs/WorkingLocally.md)|
216
+|Shared Element Transition|     :x:  |✅| [Contribute](/docs/docs/WorkingLocally.md)|
217
+| splitViewScreen       |     :x:  |    ✅      | [Contribute](/docs/docs/WorkingLocally.md)|