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

Simplify documentation, remove extraneous content #850

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

irvinebroque
Copy link

@irvinebroque irvinebroque commented Aug 4, 2024

Reorients the docs to be focused on people who rely on next-on-pages, rather than long internal details. Consistently redirects readers to this page to get started.

refs cloudflare/cloudflare-docs#15995

Changes

  • Simple homepage that explains what this is, directs to getting started, and summarizes the three packages in this repo and what you use them for
  • Removes a lot of pages of content that can be more clearly summarized as part of these docs.

Copy link

changeset-bot bot commented Aug 4, 2024

🦋 Changeset detected

Latest commit: bcfc1bd

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
eslint-plugin-next-on-pages Patch
@cloudflare/next-on-pages Patch

Not sure what this means? Click here to learn what changesets are.

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

Copy link
Contributor

github-actions bot commented Aug 4, 2024

🧪 Prereleases are available for testing 🧪

@cloudflare/next-on-pages

You can install this latest build in your project with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/next-on-pages/runs/10240052302/npm-package-next-on-pages-850

@cloudflare/eslint-plugin-next-on-pages

You can install this latest build in your project with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/next-on-pages/runs/10240052302/npm-package-eslint-plugin-next-on-pages-850

Copy link
Contributor

@IgorMinar IgorMinar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some of the changes in this PR are great, but I think it's not great that we are removing so much of the valuable content, which I don't move in cloudflare/cloudflare-docs#15971

Perhaps, cut back on cutting back? :)

I'm all for simplification of docs, but not at the cost of information loss. I do think that most of these docs should live in the cloudflare-docs repo, so moving more content there is very desirable IMO. I also think that cloudflare-docs can't be a single doc as it is now because it's becoming unwieldy.

How about this, what if @kodster28 took a look at all your proposed changes and made a plan for landing them in a way where valuable content is not lost?

@irvinebroque
Copy link
Author

All the relevant content here should be in cloudflare/cloudflare-docs#15995 which is ready for review.

@irvinebroque
Copy link
Author

cloudflare/cloudflare-docs#15995 has been merged.

Would like to move forward here, happy to setup pages that redirect to relevant sections.

@irvinebroque
Copy link
Author

Bump now that cloudflare/cloudflare-docs#15995 has landed?

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.

2 participants