Closed afolson closed 7 months ago
Name | Link |
---|---|
Latest commit | a089647d53efc16c22276d291c7962d251fffc71 |
Latest deploy log | https://app.netlify.com/sites/scintillating-strudel-60ff56/deploys/66197a76adeca90008c9873c |
Deploy Preview | https://deploy-preview-196--scintillating-strudel-60ff56.netlify.app |
Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site configuration.
@SirCipher @ajay-gov @cwjames19 Finally got this figured out if you want to take a look. Each section of the docs is its own collection in Jekyll since we can't have collections nested within collections, but the sections will appear grouped into one high level collection (server or client) when navigating the site.
@afolson, this looks good. One thing, when on https://deploy-preview-196--scintillating-strudel-60ff56.netlify.app/server/java/ and you click on 'Getting Started' in the sub-header it takes you to a getting started page which is language-agnostic. To me, the getting started link should be specific to Java as that is the context it is contained within (under a sub-header) but it takes you to a more general section that just contains the fundamentals and a mixture of Java and JS code blocks. I think the getting started section is probably best under its own link in the header (next to server/client/community) for people who are completely new to SwimOS - as they might not know whether they need the client or server section to get started.
I think the getting started section is probably best under its own link in the header (next to server/client/community) for people who are completely new to SwimOS - as they might not know whether they need the client or server section to get started.
Maybe instead of "Getting Started", we can call it "SwimOS Concepts". The Getting Started Section also has the Java Libraries, we should move that under the Java section
Overall, it looks great. Only small thing I saw was the header at http://localhost:4000/client/typescript/ still says "Frontend". We should change it to say "Typescript".
@afolson Thanks for renaming the "Frontend" section to "Typescript". I see now that the "Introduction" group of articles got moved to the bottom of the list. Can we push them back up to the top?
@cwjames19 Fixed!
Overhauls docs structure so that we can have sections for server/client docs for each language.
Todos:
Document how to add new sectionshttps://github.com/swimos/swimos-docs/issues/202Overhaul home page to direct folks to relevant documentationhttps://github.com/swimos/swimos-docs/issues/203