You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,19 +50,20 @@ Volunteers are always welcome!
50
50
-[Conventions](./Documentation/conventions.md)
51
51
52
52
## Development
53
-
To get started, make sure you have Node.js installed (for instance
54
-
through https://github.com/nvm-sh/nvm), and:
55
-
1. run
53
+
54
+
To get started, make sure you have Node.js installed (for instance through [nvm](https://github.com/nvm-sh/nvm)), then:
55
+
56
+
1. Clone, install, and start the dev server:
57
+
56
58
```sh
57
59
git clone https://github.com/solidos/solid-panes
58
60
cd solid-panes
59
61
npm install
60
-
npm run start
62
+
npm start
61
63
```
62
-
2. a browser window should automatically open at http://localhost:9000, if for some reason it doesn't go ahead and manually navigate there.
63
-
3. Once you arrive at the Solid Pane Tester page, the `profile-pane` will be loaded by default. Proceed to edit `solid-panes/dev/loader.ts` and, at line 5, you should see `import Pane from 'profile-pane'`. Simply change `'profile-pane'` to your preferred pane/directory containing the pane of choice; for example, you could choose `'source-pane'` and bam, it will load that pane. For those who are new, you can go to the `solid-panes/src` directory and manually navigate through each individual folder. In most folders, you simply look for any file that has `pane` in the title. Copy and paste the `pane.js` file of your choice into the `solid-panes/dev/pane` folder, or you can import directly from the `src` directory. For example, importing from `'../src/dokieli/dokieliPane'` will work just fine. Each time you save `solid-panes/dev/loader.ts` while importing a different pane, your browser at `http://localhost:9000/` should automatically refresh. It's a good idea to keep the developer console open in your web browser to ensure panes are loading and rendering properly.
64
+
2. Open http://localhost:5173 in your browser. You should see the pane development sandbox.
64
65
65
-
4. Another tip: to ensure you arrive at the proper destination, look at lines 48–53 in `solid-panes/dev/loader.ts`. You should see an event listener that is ready for a string. `renderPane('https://solidos.solidcommunity.net/Team/SolidOs%20team%20chat/index.ttl#this')` will be the default. Depending on the `pane.js` that you chose in the earlier import statements, the `renderPane` function determines the way you will see DOMContent inside of that particular pane. If you have created an `index.html` in your provider pod storage area, you could use `'https://yoursolidname.solidcommunity.net/profile/index.html'` inside of the `renderPane()` function parameters. You can edit the string manually in `solid-panes/dev/loader.ts`, or you can go to your developer console and type `renderPane('https://yoursolidname.solidcommunity.net/profile/index.html')` — just point to a part of your account that is congruent to the pane that you wish to import! :)
66
+
3.You can change the `subject`in the sandbox to determine which pane gets rendered. For example, the default subject loads the `profile-pane`.
66
67
67
68
## Contributing panes
68
69
When you created a pane, you can either add it as an npm dependency
@@ -80,8 +81,8 @@ pane. Any other pane which wants to deal with contacts can just use the pane wit
80
81
81
82
82
83
## Generative AI usage
83
-
The SolidOS team is using GitHub Copilot integrated in Visual Studio Code.
84
-
We have added comments in the code to make it explicit which parts are 100% written by AI.
84
+
The SolidOS team is using GitHub Copilot integrated in Visual Studio Code.
85
+
We have added comments in the code to make it explicit which parts are 100% written by AI.
85
86
86
87
### Prompt usage hitory:
87
88
* Model Claude Opus 4.6: Initially solid-panes is loaded into an HTML shell form mashlib that looks like ... Also, an iFrame is rendered inside the `<div class="TabulatorOutline" id="DummyUUID">` for “isolated pane rendering”. Analyze the solid-panes code for what it uses from this HTML and suggest a new HTML structure which is mobile and accessibility friendly. Let's go ahead and make changes in this code as suggested to accommodate the new databrowser HTML.
@@ -121,4 +122,3 @@ I want the menu to have a tiny button on the bottom margin left with an arrow to
121
122
* Raptor mini: Please always keep the footer at the bottom of the menu
122
123
123
124
* GPT-5.4 Model: Add a compatibility shim in the form pane for mixed `ui:Group` plus field typing.
0 commit comments