SM-Docs-API: Add initial documentation to the site

[palisadoes]

Our switchmap-ng repo is actively used by companies. It has become dormant and some packages are out of date. We plan to add this application to GSOC 2025 to revive it.

The exisiting monorepo will be split into a multirepo to simplify the code and allow easier contributor specialization. Four new repositories have been created for this purpose:

1. switchmap-ng-docs the main Docusaurus based documentation website at https://docs.switchmap-ng.io/
2. switchmap-ng-web the web UI repo with a Docusaurus docs/ directory. The documentation can be found at https://docs-web.switchmap-ng.io/
3. switchmap-ng-poller the poller repo with a Docusaurus docs/ directory. The documentation can be found at https://docs-poller.switchmap-ng.io/
4. switchmap-ng-api the API repo with a Docusaurus docs/ directory. The documentation can be found at https://docs-api.switchmap-ng.io/

In anticipation of this we need to update the documentation and migrate it to the respective repositories. The documentation can be found here:

• https://github.com/PalisadoesFoundation/switchmap-ng/tree/main/docs/source

Requirements

Each website must use the same CSS and NavBar

There are multiple related requirements. Multiple PRs will be required:

1. First, update the site's CSS and NavBar
2. Second, update the documentation
3. Finally, update the home page

CSS

The person assigned the issue in the docs.switchmap-ng.io should lead the CSS standardization. Ideally only one copy of the stylesheet must be used.

The current site look and feel is not optimal. We need it to be more modern. The Hasura v3.0 documentation site has an attractive color scheme that matches our desired approach.

• https://hasura.io/docs/3.0/index/

1. Convert the CSS in this repo that's used for https://docs.switchmap-ng.io to match that of https://hasura.io/docs/3.0/index/
2. The reference CSS should be available here:
   • https://github.com/hasura/ddn-docs/tree/main
3. We don't want a collapsible left drawer.
   
4. We want dark/light mode capabilities
5. We don't need search capabilities. Google works just fine.

NavBar

The person assigned the issue in the docs.switchmap-ng.io should lead the NavBar standardization.

The NavBar must have entries for:

1. General that links to https://docs.switchmap-ng.io/
2. Web that links to https://docs-web.switchmap-ng.io/
3. Poller that links to https://docs-poller.switchmap-ng.io/
4. API that links to https://docs-api.switchmap-ng.io/

Until we have a switchmap-ng logo, use the Palisadoes Foundation logo in the top left

The NavBar must be identical across all sites.

Homepage

We want to update the home page. You can take inspiration from the projects listed here as "Favorites": https://docusaurus.io/showcase

The home page of this site and the others referenced before must each be unique to reduce confusion for the user.

1. You must use the updated CSS. The color scheme must match.
2. We need a more intuitive layout to access the links to other https://docs.switchmap-ng.io/ pages
   1. The features listed on the current home page must be easily accessible
   2. Ideally, we should have fewer links.
      1. Developer Guides: We need to separate links to autogenerated documentation and the manual general content in a more intuitive way.
      2. User Guides: A separate sidebar should be considered
      3. Features (Maybe)
   3. These sites have used interesting approaches with multiple context specific side bars:
      6. https://wiki.iota.org/
      7. https://reactnative.dev/
      8. https://developers.atinternet-solutions.com/piano-analytics/
3. The links in the footer must match Talawa-Docs
4. The look and feel must be professional with minimal use of imagery.
   1. A reactive card based approach is ideal.
   2. Have a attractive, distinctive, prominent card, slider, or hero at the top specific to this repo
   3. All content below must match that of the docs.switchmap.io repo

Documentation

1. The current Switchmap-NG documentation can be found here:
   1. https://switchmap-ng.readthedocs.io/en/latest/index.html
2. The source code can be found here:
   1. https://github.com/PalisadoesFoundation/switchmap-ng/tree/main/docs/source
3. Add the following pages from the original repo. Make sure the links don't break:
   1. All pages except:
      2. Introduction
      3. Community

The content will be edited later

Other

Describe alternatives you've considered

• N/A

Approach to be followed (optional)

• N/A

Additional context

• This CSS will be the basis for all Palisadoes Foundation Docusaurus based websites

Potential internship candidates

Please read this if you are planning to apply for a Palisadoes Foundation internship

• https://github.com/PalisadoesFoundation/developer-docs/issues/359

[github-actions]

Congratulations on making your first Issue! 🎊 If you haven't already, check out our Contributing Guidelines and Issue Reporting Guidelines to ensure that you are following our guidelines for contributing and making issues.

[palisadoes]

@karthik-nair-20 , @Sourya07 you may want to work on this

[karthik-nair-20]

Thanksyou @palisadoes , yes I wish to contribute.

[Abhi-MS]

@karthik-nair-20 Can we connect on Slack to collaborate?

[karthik-nair-20]

yes sure @Abhi-MS my slack account - U08744V2C2V, pls ping me

[github-actions]

This issue did not get any activity in the past 10 days and will be closed in 180 days if no update occurs. Please check if the main branch has fixed it and report again or close the issue.

[palisadoes]

@karthik-nair-20

This Issue isn't complete.

1. The home page content has not been added
   Feature/update homepage switchmap-ng-docs#19
2. The pages below were not added, as stated in the issue above
   

[karthik-nair-20]

sure sir,I will create by tomorrow.

[palisadoes]

@karthik-nair-20

1. The required docs can be found here:
   1. https://github.com/PalisadoesFoundation/switchmap-ng-web/tree/develop/docs/docs
2. Design
   1. Make the homepage look like this
      1. https://docs.switchmap-ng.io/
   2. Based on the design here:
      1. https://github.com/PalisadoesFoundation/switchmap-ng-docs
   3. Make the NavBar link to the /docs page of each site listed

[github-actions]

This issue did not get any activity in the past 10 days and will be closed in 180 days if no update occurs. Please check if the main branch has fixed it and report again or close the issue.

[palisadoes]

Unassigning. Inactivity