Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update developer guide, removed unused code and CSS #918

Merged
merged 10 commits into from
Aug 23, 2024
42 changes: 16 additions & 26 deletions docs/developer_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -115,13 +115,13 @@ Repo Structure
- `src`
- `electron`
- `main`
- `src` - Contains all the source code for the backend
- `assets` - Contains all the backend-facing assets (e.g. images, css, etc.)
- `application-menu.js` - Configures the application window
- `main.ts` - Configures the Python backend process
- `preload`
- `preload.js` - Exposes electron-specific variables to the frontend
- `frontend`
- `core` - Contains all the source code for the frontend
- `index.js` - The entry point for the application
- `index.ts` - The entry point for the application. Manages initial system and internet connection checks, and sets up auto-updating
- `pages.js` - The main code that controls which pages are rendered and how they are linked together
- `components` - Contains all the UI Components used throughout the app
- `assets` - Contains all the frontend-facing assets (e.g. images, css, etc.)
Expand Down Expand Up @@ -160,47 +160,37 @@ Starting a New Feature
Adding a New Page
^^^^^^^^^^^^^^^^^

New pages can be added by linking a component in the ``src/pages.js`` file. For example, if you wanted to
add a new page called ``NewPage``, you would add the following to the configuration file:
New pages can be added by linking a component in the ``src/electron/frontend/core/pages.js`` file.
For example, if you wanted to add a new page called ``NewPage``, you would add the following to the configuration file:

.. code-block:: javascript

import NewPage from "./stories/pages/NewPage";
import NewPage from "./components/pages/new_page/NewPage";

// ...

const pages = {

// ...

'guided': new GuidedHomePage({
label: "Guided Mode",
icon: guidedIcon,
pages: {
start: new GuidedStartPage({
label: "Start",
}),
uploads: new UploadsPage({
label: "Upload",
icon: uploadIcon,
}),

// ...

newpage: new NewPage({
label: "New Page", // This is the label that will be displayed in the sidebar
}),

// ...

},
})
newpage: new NewPage({
label: "New Page", // This is the label that will be displayed in the sidebar
}),

// ...

}
}

// ...

This will automatically add the new page to the sidebar. The page itself can be defined in the
``src/stories/pages/NewPage.js`` file. For example, if you wanted to add a new page that displays
a simple message, you could add the following to the ``src/stories/pages/NewPage.js`` file:
``./components/pages/new_page/NewPage.js`` file. For example, if you wanted to add a new page that displays
a simple message, you could add the following to the ``./components/pages/new_page/NewPage.js`` file:


.. code-block:: javascript
Expand Down
2 changes: 1 addition & 1 deletion docs/format_support.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Ecosystem Format Support
=======================================
========================
The following is a live record of all the supported formats in the NWB GUIDE and underlying ecosystem.

.. raw:: html
Expand Down
123 changes: 0 additions & 123 deletions src/electron/frontend/assets/css/guided.css
Original file line number Diff line number Diff line change
Expand Up @@ -463,13 +463,6 @@
flex-grow: 1;
}

.guided--container-permissions {
width: 800px;
display: flex;
flex-direction: row;
align-items: center;
}

.guided--container-data-display {
display: flex;
width: 90%;
Expand Down Expand Up @@ -1345,122 +1338,6 @@ h1.guided--text-sub-step {
}
}

.asideContainer {
border: 2px solid lightgray;
}

.asideTitleContainer {
padding-top: 0;
border-radius: 0;
border: none;
border-right: 2px solid lightgray;
}

.asideTitle {
background: lightgray;
padding: 12px 0 15px 0;
border-radius: 0;
}

.border-styling {
border: 2px solid lightgray;
}

.before-getting-started-btn {
margin-bottom: 1.5rem;
}
.lds-roller {
display: inline-block;
position: relative;
width: 80px;
height: 80px;
}
.lds-roller div {
animation: lds-roller 1.2s cubic-bezier(0.5, 0, 0.5, 1) infinite;
transform-origin: 40px 40px;
}
.lds-roller div:after {
content: " ";
display: block;
position: absolute;
width: 7px;
height: 7px;
border-radius: 50%;
background: var(--color-light-green);
margin: -4px 0 0 -4px;
}
.lds-roller div:nth-child(1) {
animation-delay: -0.036s;
}
.lds-roller div:nth-child(1):after {
top: 63px;
left: 63px;
}
.lds-roller div:nth-child(2) {
animation-delay: -0.072s;
}
.lds-roller div:nth-child(2):after {
top: 68px;
left: 56px;
}
.lds-roller div:nth-child(3) {
animation-delay: -0.108s;
}
.lds-roller div:nth-child(3):after {
top: 71px;
left: 48px;
}
.lds-roller div:nth-child(4) {
animation-delay: -0.144s;
}
.lds-roller div:nth-child(4):after {
top: 72px;
left: 40px;
}
.lds-roller div:nth-child(5) {
animation-delay: -0.18s;
}
.lds-roller div:nth-child(5):after {
top: 71px;
left: 32px;
}
.lds-roller div:nth-child(6) {
animation-delay: -0.216s;
}
.lds-roller div:nth-child(6):after {
top: 68px;
left: 24px;
}
.lds-roller div:nth-child(7) {
animation-delay: -0.252s;
}
.lds-roller div:nth-child(7):after {
top: 63px;
left: 17px;
}
.lds-roller div:nth-child(8) {
animation-delay: -0.288s;
}
.lds-roller div:nth-child(8):after {
top: 56px;
left: 12px;
}
@keyframes lds-roller {
0% {
transform: rotate(0deg);
}
100% {
transform: rotate(360deg);
}
}

.tippy-box[data-theme~="soda"] {
background-color: #13716d;
color: white;
/* white-space: nowrap; */
/* overflow: hidden; */
}

.tippy-box[data-theme~="soda"][data-placement^="top"] > .tippy-arrow::before {
border-top-color: #13716d;
}
7 changes: 0 additions & 7 deletions src/electron/frontend/assets/css/individualtab.css
Original file line number Diff line number Diff line change
Expand Up @@ -1206,13 +1206,6 @@
.card-right.bf-account-span,
.card-right.bf-account-details-span,
.card-right.bf-dataset-span,
.card-right.current-permissions {
width: auto;
margin-left: 5px;
margin-top: 0px;
padding-left: 5px;
}

.card-container.manage-dataset .card-right.bf-dataset-span {
width: fit-content;
}
Expand Down
Loading
Loading