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

feat: Upgrading documentation #351

Open
wants to merge 26 commits into
base: develop
Choose a base branch
from
Open

feat: Upgrading documentation #351

wants to merge 26 commits into from

Conversation

KanishkKhurana
Copy link
Contributor

Why?

The docs structure has been confusing and distracting for a while. When someone wants to host a site on fleek or use fleek functions, we always split their attention between platform and cli instead of providing details on the value proposition and letting them take a decision thereafter.

therefore this PR has been raised to fix structural issues, developer experience issues and overall state of the docs.

some references have been drawn from this notion page made by some members of the product and devrel team -
https://www.notion.so/fleek/Docs-Revision-Proposal-128f6926f8dc804bba31fcf1da985f4b

How?

  • Introduce guided selectors everywhere
  • defined overview pages
  • used tabs for platform and cli
  • use features on the sidebar instead of platform and cli
  • revamped some content on the docs

Contribution checklist?

  • The commit messages are detailed
  • The build command runs locally
  • Assets or static content are linked and stored in the project
  • Document filename is named after the slug
  • You've reviewed spelling using a grammar checker
  • For documentation, guides or references, you've tested the commands and steps
  • You've done enough research before writing

Preview?

Screen.Recording.2024-12-12.at.5.55.04.PM.mov

KanishkKhurana and others added 23 commits November 8, 2024 22:46
## Why?

This pull request adds in documentation for the platform categories of
the docs for "Create and deploy" under "Fleek Functions" and also under
for fullstack Next.js.


## Contribution checklist?

- [x] The commit messages are detailed
- [x] The `build` command runs locally
- [x] Assets or static content are linked and stored in the project
- [x] Document filename is named after the slug
- [x] You've reviewed spelling using a grammar checker
- [x] For documentation, guides or references, you've tested the
commands and steps
- [x] You've done enough research before writing

## Security checklist?

- [x] Sensitive data has been identified and is being protected properly
- [x] Injection has been prevented (parameterized queries, no eval or
system calls)
- [x] The Components are escaping output (to prevent XSS)
Copy link

changeset-bot bot commented Dec 12, 2024

⚠️ No Changeset found

Latest commit: 96de4e4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

src/content/docs/index.mdx Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants