Skip to content

Commit 576dacb

Browse files
authored
refactor(docs): normalize dir naming and casing (Semantic-Org#2863)
* refactor(docs): app -> src * refactor(docs): build -> dist * refactor(docs): src/Components -> src/components * refactor(docs): src/Examples -> src/examples * refactor(docs): src/HOC -> src/hoc * refactor(docs): src/Layouts -> src/layouts * refactor(docs): src/Views -> src/views * refactor(docs): rename directories in git
1 parent fd269d6 commit 576dacb

File tree

1,718 files changed

+14470
-13784
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,718 files changed

+14470
-13784
lines changed

.eslintignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
coverage/*
22
dist/*
3-
docs/build/*
3+
docs/dist/*
44
examples/webpack3/scripts/*
55
dll/*

.github/CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -518,7 +518,7 @@ Label.propTypes = {
518518

519519
>This section is lacking in instruction as the the docs are set to be overhauled (PRs welcome!).
520520
521-
Usage examples for a component live in `docs/app/Examples`. The examples follow the SUI doc site examples.
521+
Usage examples for a component live in `docs/src/examples`. The examples follow the SUI doc site examples.
522522

523523
Adding documentation for new components is a bit tedious. The best way to do this (for now) is to copy an existing component's and update them.
524524

.gitignore

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77

88
coverage/
99
dist/
10-
docs/app/componentInfo
11-
docs/app/componentMenu.json
12-
docs/app/exampleMenus
13-
docs/build/
10+
docs/src/componentInfo
11+
docs/src/componentMenu.json
12+
docs/src/exampleMenus
13+
docs/dist/
1414
dll/
1515
node_modules/

.prettierignore

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ coverage/
99

1010
dist/
1111
dll/
12-
docs/app/componentInfo
13-
docs/app/componentMenu.json
14-
docs/app/exampleMenus
15-
docs/build/
12+
docs/src/componentInfo
13+
docs/src/componentMenu.json
14+
docs/src/exampleMenus
15+
docs/dist/
1616

1717
package.json

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- Logo -->
22
<p align="center">
33
<a href="https://react.semantic-ui.com">
4-
<img height="128" width="128" src="https://github.com/Semantic-Org/Semantic-UI-React/raw/master/docs/app/logo.png">
4+
<img height="128" width="128" src="https://github.com/Semantic-Org/Semantic-UI-React/raw/master/docs/src/logo.png">
55
</a>
66
</p>
77

@@ -42,11 +42,11 @@ See the [**Documentation**][2] for an introduction, usage information, and examp
4242

4343
## Built With
4444

45-
<img align="left" height="50" src="https://github.com/Semantic-Org/Semantic-UI-React/raw/master/docs/app/amazon-logo.png" />
46-
<img align="left" height="50" src="https://github.com/Semantic-Org/Semantic-UI-React/raw/master/docs/app/netflix-logo.png" />
47-
<img align="left" height="50" src="https://github.com/Semantic-Org/Semantic-UI-React/raw/master/docs/app/microsoft-logo.png" />
45+
<img align="left" height="50" src="https://github.com/Semantic-Org/Semantic-UI-React/raw/master/docs/src/amazon-logo.png" />
46+
<img align="left" height="50" src="https://github.com/Semantic-Org/Semantic-UI-React/raw/master/docs/src/netflix-logo.png" />
47+
<img align="left" height="50" src="https://github.com/Semantic-Org/Semantic-UI-React/raw/master/docs/src/microsoft-logo.png" />
4848
<a href="https://github.com/Semantic-Org/Semantic-UI-React/edit/master/README.md">
49-
<img height="50" src="https://github.com/Semantic-Org/Semantic-UI-React/raw/master/docs/app/add-yours.png" />
49+
<img height="50" src="https://github.com/Semantic-Org/Semantic-UI-React/raw/master/docs/src/add-yours.png" />
5050
</a>
5151

5252
- Amazon Publishing — the full-service publisher of Amazon — [APub.com](https://amazonpublishing.amazon.com)

config.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ const envConfig = {
1818
dir_src: 'src',
1919
dir_dist: 'dist',
2020
dir_dll: 'dll',
21-
dir_docs_dist: 'docs/build',
22-
dir_docs_src: 'docs/app',
21+
dir_docs_dist: 'docs/dist',
22+
dir_docs_src: 'docs/src',
2323
}
2424

2525
// ------------------------------------

docs/app/Components/ComponentDoc/ContributionPrompt.js

-28
This file was deleted.

docs/app/Components/ComponentDoc/ShorthandExample.js

-16
This file was deleted.

docs/app/Examples/addons/Confirm/Types/index.js

-20
This file was deleted.

docs/app/Examples/addons/Confirm/Variations/index.js

-30
This file was deleted.

docs/app/Examples/addons/MountNode/Types/index.js

-16
This file was deleted.

docs/app/Examples/addons/Pagination/Types/PaginationExamplePagination.js

-8
This file was deleted.

docs/app/Examples/addons/Pagination/Types/index.js

-16
This file was deleted.

docs/app/Examples/addons/Pagination/Usage/PaginationExampleControlled.js

-28
This file was deleted.

docs/app/Examples/addons/Pagination/Usage/index.js

-31
This file was deleted.

docs/app/Examples/addons/Portal/Types/index.js

-21
This file was deleted.

docs/app/Examples/addons/Radio/States/RadioExampleChecked.js

-8
This file was deleted.

docs/app/Examples/addons/Radio/States/RadioExampleReadOnly.js

-8
This file was deleted.

docs/app/Examples/addons/Radio/States/RadioExampleRemoteControl.js

-22
This file was deleted.

docs/app/Examples/addons/Radio/States/index.js

-43
This file was deleted.

docs/app/Examples/addons/Radio/Types/RadioExampleRadio.js

-8
This file was deleted.

0 commit comments

Comments
 (0)