-
Notifications
You must be signed in to change notification settings - Fork 3
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
Conversation
✅ Deploy Preview for scintillating-strudel-60ff56 ready!
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. |
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! |
There was a problem hiding this 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!
Overhauls docs structure so that we can have sections for server/client docs for each language.
Todos:
Document how to add new sectionsmeta: Document how to add new sections to documentation #202Overhaul home page to direct folks to relevant documentationdocs: Update home page and server/client index pages to highlight the most important information #203