Skip to content

Commit 1816a06

Browse files
timea-solidtimea-solid
committed
renamed the documentation folder
1 parent bb2b3d3 commit 1816a06

44 files changed

Lines changed: 68 additions & 68 deletions

Some content is hidden

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

‎.gitignore‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ src/versionInfo.ts
55
.idea
66
.vscode
77
coverage
8-
Documentation/api
8+
docs/api
99
examples/storybook
1010
.history/
11-
Documentation/form-examples/main.js
11+
docs/form-examples/main.js

‎README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ These are HTML5 widgets which connect to a solid store. Building blocks for soli
88
Vanilla JS. Includes large widgets like chat, table, matrix, form fields, and small widgets.
99

1010
See [Solid-Ui Storybook](http://solidos.github.io/solid-ui/examples/storybook/) for SolidUI widgets.
11-
See [Solid-UI API](https://solidos.github.io/solid-ui/Documentation/api/) for SolidUI functions.
12-
See [Forms introduction](./Documentation/FormsReadme.md) for UI vocabulary implementation.
11+
See [Solid-UI API](https://solidos.github.io/solid-ui/docs/api/) for SolidUI functions.
12+
See [Forms introduction](./docs/FormsReadme.md) for UI vocabulary implementation.
1313

1414
Table of content:
1515
- Getting started(#getting-started)
@@ -36,8 +36,8 @@ Clone this repo, and in the repo root run:
3636
* `npm install`
3737
* `npm run build`
3838

39-
This will generate a `dist/` folder containing, among other artifacts, `dist/main.js`.
40-
Now run `npx serve` and go to http://localhost:3000/Documentation/ with your browser to see some examples.
39+
This will generate a `dist/` folder containing, among other artifacts, `dist/solid-ui.js`.
40+
Now run `npx serve` and go to http://localhost:3000/docs/ with your browser to see some examples.
4141

4242
While viewing one of those examples, you can open the web console in your browser and for instance
4343
try how you can create a button:

Documentation/FormsReadme.md renamed to docs/FormsReadme.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -30,36 +30,36 @@ In the [form-playground](https://solidos.github.io/form-playground/playground.ht
3030

3131
To make use of Forms, you need to use solid-ui. Head over to the [solid-ui readme](https://github.com/SolidOS/solid-ui/blob/main/README.md#getting-started) for some how-to guides on how to use it in `npm` or as a `html <script>`.
3232

33-
Once you are set up with the code, take a look at some examples over at [solid-ui/Documentation](<https://github.com/SolidOS/solid-ui/tree/main/Documentation>). The examples there are also deployed on Git Pages:
33+
Once you are set up with the code, take a look at some examples over at [solid-ui/docs](<https://github.com/SolidOS/solid-ui/tree/main/docs>). The examples there are also deployed on Git Pages:
3434

35-
- [Basic Form Demo](https://solidos.github.io/solid-ui/Documentation/form-examples/demo.html)
36-
- [WebID profile Demo](https://solidos.github.io/solid-ui/Documentation/form-examples/profile-demo.html)
37-
- [ui:Form and ui:Group examples](https://solidos.github.io/solid-ui/Documentation/form-examples/structures.html)
38-
- [ui:Classifier and ui:Options example](https://solidos.github.io/solid-ui/Documentation/form-examples/structures2.html)
39-
- [ui:Choice example](https://solidos.github.io/solid-ui/Documentation/form-examples/structures3.html)
40-
- if you want, you can try to wrap your head around [a rendering of the entire UI vocabulary](https://solidos.github.io/solid-ui/Documentation/form-examples/edit-form-form.html) _(Scroll to the far right if all you see is a column or two of plain text...)_
35+
- [Basic Form Demo](https://solidos.github.io/solid-ui/docs/form-examples/demo.html)
36+
- [WebID profile Demo](https://solidos.github.io/solid-ui/docs/form-examples/profile-demo.html)
37+
- [ui:Form and ui:Group examples](https://solidos.github.io/solid-ui/docs/form-examples/structures.html)
38+
- [ui:Classifier and ui:Options example](https://solidos.github.io/solid-ui/docs/form-examples/structures2.html)
39+
- [ui:Choice example](https://solidos.github.io/solid-ui/docs/form-examples/structures3.html)
40+
- if you want, you can try to wrap your head around [a rendering of the entire UI vocabulary](https://solidos.github.io/solid-ui/docs/form-examples/edit-form-form.html) _(Scroll to the far right if all you see is a column or two of plain text...)_
4141

42-
Most interesting may be how it is all wired together in the [test-form.js](https://github.com/SolidOS/solid-ui/blob/main/Documentation/form-examples/test-form.js), while the code for the form itself is mostly under [solid-ui/src/widgets/forms.js](https://github.com/SolidOS/solid-ui/blob/main/src/widgets/forms.js).
42+
Most interesting may be how it is all wired together in the [test-form.js](https://github.com/SolidOS/solid-ui/blob/main/docs/form-examples/test-form.js), while the code for the form itself is mostly under [solid-ui/src/widgets/forms.js](https://github.com/SolidOS/solid-ui/blob/main/src/widgets/forms.js).
4343

4444
## Running or testing it locally
4545

46-
Locally you can setup your own test of forms. All you need is the `/Documentation/form-examples` folders and the `test-form.js`.
46+
Locally you can setup your own test of forms. All you need is the `/docs/form-examples` folders and the `test-form.js`.
4747

48-
1. First build solid-ui locally and copy it to `/Documentation/form-examples`
48+
1. First build solid-ui locally and copy it to `/docs/form-examples`
4949
Run this instruction which will do all that for you.
5050
```
5151
npm run build-form-examples
5252
```
5353
2. Use the newly build solid-ui (called main.js) in your html.
5454
You need to use the new build main.js:
55-
* uncommenting the usage of the main.js script; Example [here](https://github.com/SolidOS/solid-ui/blob/4f620aea3e91daf5ce9591dd83d3c95c161a44ad/Documentation/form-examples/structures3.html#L21)
56-
* commenting out the mashlib.js usage. Example [here](https://github.com/SolidOS/solid-ui/blob/4f620aea3e91daf5ce9591dd83d3c95c161a44ad/Documentation/form-examples/structures3.html#L15)
55+
* uncommenting the usage of the main.js script; Example [here](https://github.com/SolidOS/solid-ui/blob/4f620aea3e91daf5ce9591dd83d3c95c161a44ad/docs/form-examples/structures3.html#L21)
56+
* commenting out the mashlib.js usage. Example [here](https://github.com/SolidOS/solid-ui/blob/4f620aea3e91daf5ce9591dd83d3c95c161a44ad/docs/form-examples/structures3.html#L15)
5757

5858
3. Use your own rad data and form
59-
Switch out the `input` and `target` (form and raw data) links. Example [here](https://github.com/SolidOS/solid-ui/blob/4f620aea3e91daf5ce9591dd83d3c95c161a44ad/Documentation/form-examples/structures3.html#L56)
59+
Switch out the `input` and `target` (form and raw data) links. Example [here](https://github.com/SolidOS/solid-ui/blob/4f620aea3e91daf5ce9591dd83d3c95c161a44ad/docs/form-examples/structures3.html#L56)
6060

6161
4. Run a local server
62-
For example run `npx vite`in the `Documentation` folder and the navigate to something like: http://localhost:3000/form-examples/profile-demo.html
62+
For example run `npx vite`in the `docs` folder and the navigate to something like: http://localhost:3000/form-examples/profile-demo.html
6363

6464
## Spin-offs & further examples
6565

Documentation/diagrams/AutocompleteStates.epgz renamed to docs/diagrams/AutocompleteStates.epgz

File renamed without changes.

Documentation/diagrams/AutocompleteStates.svg renamed to docs/diagrams/AutocompleteStates.svg

File renamed without changes.

Documentation/diagrams/PersonalPublicDataLinks.drawio renamed to docs/diagrams/PersonalPublicDataLinks.drawio

File renamed without changes.

Documentation/diagrams/PersonalPublicDataLinks.svg renamed to docs/diagrams/PersonalPublicDataLinks.svg

File renamed without changes.

Documentation/diagrams/solid-ui-block-diagram.epgz renamed to docs/diagrams/solid-ui-block-diagram.epgz

File renamed without changes.

Documentation/diagrams/solid-ui-block-diagram.svg renamed to docs/diagrams/solid-ui-block-diagram.svg

File renamed without changes.

Documentation/form-ecosystem.html renamed to docs/form-ecosystem.html

File renamed without changes.

0 commit comments

Comments
 (0)