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: update index and beta pages #56

Merged
merged 6 commits into from
Oct 23, 2023

Conversation

cfu288
Copy link
Contributor

@cfu288 cfu288 commented Oct 19, 2023

Opening a draft PR for proposed changes as part of the re-organization of the docs repo.

I think the first three pages to the docs site should be the following:

  1. Welcome - Intro, explain what Fasten is, give user actionable next steps
  2. What can Fasten do? - List and demo of current features
  3. Getting started with Fasten - Installation instructions for the Fasten beta

Current tasks:

  • Improve welcome/index page with gentler onboarding and actionable buttons to guide users to next steps
  • Add a "What can fasten do?" page with a quick overview of Fasten in its current state with videos/pictures.
  • Update the beta page to a "Getting started" page with guided installation instructions

BETA.md Outdated Show resolved Hide resolved
@AnalogJ
Copy link
Member

AnalogJ commented Oct 19, 2023

This is a fantastic start, thanks @cfu288 !

beta/main.md Outdated Show resolved Hide resolved
@AnalogJ
Copy link
Member

AnalogJ commented Oct 23, 2023

Hey @cfu288 this looks pretty good, other than a couple of small nits. However its still in Draft, should I mark it ready for review and merge it? Or do you have plans to make more changes?

@cfu288
Copy link
Contributor Author

cfu288 commented Oct 23, 2023

@AnalogJ Ah, in my mind its a WIP since I was planning on adding a bit more before merge and proofreading. If you're happy with it we can merge it now and I'll make another PR with the "What can fasten do?" feature demo page.

@cfu288 cfu288 marked this pull request as ready for review October 23, 2023 19:01
@cfu288 cfu288 force-pushed the feat/improve-onboarding-docs branch from 70a54c2 to bd66fa7 Compare October 23, 2023 19:08
@AnalogJ
Copy link
Member

AnalogJ commented Oct 23, 2023

yeah, I lean towards making small PR's without long lived branches. I plan on making some changes to the docs repo myself as well, and I don't want to introduce any conflicts with your work.

@cfu288
Copy link
Contributor Author

cfu288 commented Oct 23, 2023

Fair enough, I'm done with changes for now - just pushed some last minute typo fixes

@AnalogJ AnalogJ merged commit bf552c4 into fastenhealth:main Oct 23, 2023
1 check passed
@AnalogJ
Copy link
Member

AnalogJ commented Oct 23, 2023

awesome, I merged your changes and they should be visible on docs.fastenhealth.com in a couple minutes.

I'll also add some info to the pre-v0.1.9 release notes issue

@cfu288 cfu288 deleted the feat/improve-onboarding-docs branch October 23, 2023 23:28
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