Update DocumentationPage.vue #24
Conversation
Slight re-wording and adding page breaks
|
I went ahead and deployed this branch to http://ember-archive.jhuapl.edu:8080/documentation to make it easy for anyone to review! |
|
For the Failing "Frontend CI / Run Prettier check": see updated README here: https://github.com/aplbrain/BBQS-EMBER-web/pull/26/files?short_path=b335630#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5 I just realized that I added the GitHub Actions workflow but didn't update the README with any instructions, so I just created a branch doing that! Let me kno wif you have any questions though |
|
Also, I think adding that visual would be useful! |
NEStock
left a comment
NEStock
left a comment
There was a problem hiding this comment.
Overall the additions/changes look good to me!
|
Rahul reviewed the document and suggested adding some changes to the beginning section to clarify that users should check if their files are compatible with current NWB before selecting their upload workflow instructions. I updated the .md in Box '~/Box-Box/NIH BBQS EMBER/BBQS Community/DANDI Notes/Instructions for EMBER-DANDI/Instructions for Interfacing with the EMBER Archive.md' accordingly to change some wording and reorganize the instructions a little bit. I think the way it displays in my markdown editor is a bit different from how it appears on the website. I agree that links to the section need to be implemented. In addition, there are a few callouts that aren't displaying that I think helps make the guide a bit more user-friendly. Having them be collapsible/foldable callouts would be ideal, not sure if that is possible on the website. For example: Note My files are all NWB/BIDS compatible, do x,y,z |
$ prettier --write "**/*.{js,ts,vue,scss,html,md,json}" --ignore-path .gitignore
.vscode/extensions.json 20ms (unchanged)
.vscode/settings.json 2ms (unchanged)
eslint.config.js 12ms (unchanged)
index.html 21ms (unchanged)
package.json 2ms (unchanged)
postcss.config.js 3ms (unchanged)
quasar.config.ts 33ms (unchanged)
README.md 25ms (unchanged)
scripts/fetchProjectMetadata.ts 20ms (unchanged)
src/App.vue 3ms (unchanged)
src/components/LinkText.vue 9ms (unchanged)
src/components/PageTitle.vue 3ms (unchanged)
src/constants/about.ts 5ms (unchanged)
src/constants/links.ts 3ms (unchanged)
src/constants/mainLayout.ts 2ms (unchanged)
src/constants/projects.ts 33ms (unchanged)
src/css/app.scss 17ms (unchanged)
src/css/quasar.variables.scss 1ms (unchanged)
src/env.d.ts 2ms (unchanged)
src/layouts/MainLayout.vue 29ms (unchanged)
src/models/about.ts 1ms (unchanged)
src/models/common.ts 0ms (unchanged)
src/models/mainLayout.ts 1ms (unchanged)
src/models/projects.ts 7ms (unchanged)
src/pages/AboutPage.vue 15ms (unchanged)
src/pages/DocumentationPage.vue 18ms (unchanged)
src/pages/ErrorNotFound.vue 3ms (unchanged)
src/pages/GettingStartedPage.vue 7ms (unchanged)
src/pages/IndexPage.vue 9ms (unchanged)
src/pages/MetadataPage.vue 2ms (unchanged)
src/pages/PrivacyPolicy.vue 11ms (unchanged)
src/pages/ProjectsPage.vue 11ms (unchanged)
src/pages/TermsOfService.vue 30ms (unchanged)
src/pages/ToolsPage.vue 2ms (unchanged)
src/router/index.ts 3ms (unchanged)
src/router/routes.ts 2ms (unchanged)
src/utils/date.ts 2ms (unchanged)
src/utils/scroll.ts 1ms (unchanged)
tsconfig.json 1ms (unchanged)
tsconfig.vue-tsc.json 1ms (unchanged)
Done in 0.83s.
…he-documentation-page Documentation Page updates
Minor changes:
Larger changes:
Potential changes to consider: