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

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

Merged
merged 15 commits into from
Apr 15, 2024
Merged

Conversation

afolson
Copy link
Contributor

@afolson afolson commented Mar 25, 2024

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

Todos:

@afolson afolson self-assigned this Mar 25, 2024
Copy link

netlify bot commented Mar 25, 2024

Deploy Preview for scintillating-strudel-60ff56 ready!

Name Link
🔨 Latest commit a089647
🔍 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
Copy link
Contributor Author

afolson commented Mar 25, 2024

@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
Copy link
Member

SirCipher commented Mar 26, 2024

@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
Copy link
Member

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
Copy link
Contributor

cwjames19 commented Mar 26, 2024

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
Copy link
Contributor

@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
Copy link
Contributor Author

afolson commented Apr 12, 2024

@cwjames19 Fixed!

Copy link
Contributor

@cwjames19 cwjames19 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@afolson Thanks for making that change. Looks good!

@afolson afolson merged commit 93e7c58 into main Apr 15, 2024
5 checks passed
@afolson afolson deleted the af-rust branch April 15, 2024 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants