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

Transfer the documentation from the original website to the new one #12

Open
sansyrox opened this issue Aug 5, 2023 · 5 comments
Open
Labels

Comments

@sansyrox
Copy link
Member

sansyrox commented Aug 5, 2023

We have initiated the process of transferring documentation from our original website to our new platform to ensure continuity and accessibility for our users.

Current Status:

Completed Migration: As of now, we have successfully migrated a significant portion of the documentation from the original website (here) to the new one.

Pending Migration: However, there is still a remaining portion that needs to be transferred to the new platform.
Next Steps:

Identify the Remaining Content: A careful review will be conducted to determine exactly what content is still left to be transferred, including any links, images, and associated files.

@sansyrox sansyrox added the latest label Aug 5, 2023
@KanishkKhurana
Copy link
Contributor

KanishkKhurana commented Aug 9, 2023

Here are some remaining documentation sections that can be transferred -

  1. Features
  2. Architecture
  3. Comparison

These can all be added in the Api Reference section of the documentation

@sansyrox
Copy link
Member Author

sansyrox commented Aug 9, 2023

@KanishkKhurana 👋

We need to find the features we have not document and then document them in the API section of the documentation.

Also, the architecture and the comparison docs should have their own section imo.

@KanishkKhurana
Copy link
Contributor

I was thinking we could add them after introduction in the Documentation header
👇🏻
Screenshot 2023-08-10 at 2 08 39 PM

@KanishkKhurana
Copy link
Contributor

pending docs that need to be transferred -

  1. Sync Requests - https://sparckles.github.io/robyn/#/features?id=synchronous-requests
  2. Separate section for all kinds of HTTP Reqs - https://sparckles.github.io/robyn/#/features?id=all-kinds-of-http-requests
  3. Format of the response - https://sparckles.github.io/robyn/#/features?id=format-of-the-response

@KanishkKhurana
Copy link
Contributor

I realised that the getting-started section of the API reference wasnt working and it contains all the missing docs. The section has been fixed and now the doc has been completed and you can find this in the existing PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants