Talawa-API: Create a new documentation website

[palisadoes]

develop-postgres branch only!

1. We have added docusaurus to the docs/ directory of the repo
2. When PRs are merged, the contents of this directory are processed to create this website

• https://docs-api.talawa.io/

Requirements

Keep this issue in mind for context:

• Refresh the docs.talawa.io website for 2025 talawa-docs#916

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

1. The first, to update the site's CSS which will be used for all pages on the site
2. Ensure the autogenerated markdown based on the code base's comments is added to the site in an intuitive way. The GitHub action that does this can be found here:
   • .github/workflows/pull-request.yml
3. Update the home page

CSS

The current site look and feel is not optimal. We need it to be more modern. The Hasura v2.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.talawa.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 to restore dark/light mode capabilities
5. We don't need search capabilities. Google works just fine.

NavBar

The NavBar must have entries for:

1. General that links to https://docs.talawa.io/
2. Mobile that links to https://docs-mobile.talawa.io/
3. Admin that links to https://docs-admin.talawa.io/
4. API that links to https://docs-api.talawa.io/

The NavBar must be identical across all sites. Coordinate with other contributors to do this.

Documentation

The existing left drawer menu items in the docs/ URI of the website and the files they reference must be removed.

1. Manual documentation
   1. Create a placeholder manual page for a User Guide. Make this a left drawer entry for this
   2. Create a placeholder manual page for a Developer Guide . Make this a left drawer entry for this
   3. Create a placeholder manual page for a Developer Guide/Reference . Make this a left drawer entry for this
2. Automated documentation
   1. Refer to .github/workflows/pull-request.yml
   2. Move the autogenerated files from the talawa-mobile-docs/ to a directory docs/auto-docs
   3. Modify .github/workflows/pull-request.yml and/or the autogeneration script(s) to create updated markdown in this directory
   4. Add these files in a menu structure under Developer Guide/Reference. Use this link as a guide for the structure
      1. https://docs.talawa.io/docs/talawa-mobile-docs

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.talawa.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:
      8. https://wiki.iota.org/
      9. https://reactnative.dev/
      10. https://developers.atinternet-solutions.com/piano-analytics/
3. The links in the footer must be unchanged
4. The look and feel must be professional with minimal use of imagery

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

[palisadoes]

@karthik-nair-20 this is for you based on the talawa-docs issue above. Please ask to be assigned.
Coordinate with @Abhi-MS

[NishantSinghhhhh]

@palisadoes , can I help too in this project

I am quite well versed with frontend Development, and have made quite good website

Repository: https://github.com/NishantSinghhhhh/Innerve9

Link : https://innerve9.vercel.app/

[palisadoes]

@palisadoes , can I help too in this project

I am quite well versed with frontend Development, and have made quite good website

Repository: https://github.com/NishantSinghhhhh/Innerve9

Link : https://innerve9.vercel.app/

Our policy is to assign no more than two issues to each contributor across all repositories. This way everyone gets a chance to participate in the projects. We sometimes give exceptions for more urgent cases and sometimes we lose track, but the policy stands. You have reached your limit, please wait until your existing issues are closed before requesting more issues. You could unassign yourself from one of the other issues too.

[karthik-nair-20]

@palisadoes thanks you, yes I wish to contribute

[karthik-nair-20]

Opened 1st PR