sparckles / docs-base Goto Github PK

if anyone would like to get their company/employer using featured in the testimonial section. DM me on discord 😄

We have two GitHub buttons on the documentation page.

Remove one of them.

Logo is not disappearing when scrolling on Navbar

I have worked on a new documentation format.

Mention me and I will be happy to share with the person picking up this task.

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.

Take it to the repo

e.g. the text is not visible on the releases page

And the text doesn't match on the documentation page.

https://robyn-docs.vercel.app/releases

We need to remove this.

Add human testimonials instead of company names. We will have to create a randomized carousel(preferably using tailwind components - https://tailwindui.com/components) to showcase the testimonials!

Can be found here - https://robyn-docs.vercel.app/

We still have a lorem ipsum section. Please remove it and replace it with some content.

Can be found here - https://robyn-docs.vercel.app/community

either fetch the tweets or make it a proper news section.

Something similar to what @AntoineRR and I discussed a while back.

Approach three - would be to just maintain a proper changelog

Danalieth — 23/03/2023 23:16
I think a versioned doc would be clearer, but if it is too difficult to maintain we can fall back to serving only the latest doc. I think we should keep this in mind when rebuilding the docs website, and see if it would be doable? Some users of Robyn might not want to have to update there code base to the latest version each time there is a breaking change, just because they cannot find the docs for the version they are currently using. I have a potential idea of how to achieve this but if you think it isn't necessary let me know 🙂
Sanskar — 23/03/2023 23:18
I was only suggesting to not do this as I was thinking this to be a bit difficult. What is the idea that you have? If that makes it any easier, I am totally in
Danalieth — 23/03/2023 23:21
The easiest solution would probably be to have several folders (v0.26.0, v0.27.0, etc) with the appropriate md files
Though I was looking at pyo3's codebase and they don't seem to have that. There release process is based on branches so they might have a logic to take the docs from each release branch and serve it. This is probably better but more difficult to do 😐

Algolia search is almost complete just needs an api key.

Ask from me

Some of the SEO description still contains the data from the Prisma client. We need to make it more pertinent.

• add sponsor section to our community page

Fix this on the home page