swimos / swimos-docs

Documentation for SwimOS
Apache License 2.0
0 stars 3 forks source link

Restructure docs to allow for language-specific sections. #196

Closed afolson closed 7 months ago

afolson commented 7 months ago

Overhauls docs structure so that we can have sections for server/client docs for each language.

Todos:

netlify[bot] commented 7 months ago

Deploy Preview for scintillating-strudel-60ff56 ready!

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...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

afolson commented 7 months ago

@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.

SirCipher commented 7 months ago

@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.

ajay-gov commented 7 months ago

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

cwjames19 commented 7 months ago

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".

cwjames19 commented 7 months ago

@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?

Screenshot 2024-04-12 at 10 21 10 AM
afolson commented 7 months ago

@cwjames19 Fixed!