Skip to content

Conversation

@tupui
Copy link
Member

@tupui tupui commented Oct 7, 2025

Adds a Docusaurus based website with docs, pages and blog support.

I moved the current docs/ content into the website/docs and used some info from the readme to do an initial pass on the Quickstart and welcome page.

For the design I used what I could find on our official website. A bit of retro-engineering there and there.

Two things:

  1. Do we want to keep this here?
  2. Where do we deploy? I can use GitHub pages for now. An alternative could be Netlify. In any case, a free tier would be more than enough as the content is static. The next step will be setting up the DNS records to reach the deployment.

To help review, for now I did a quick deployment on my account:

https://scaffold-stellar.netlify.app

@tupui tupui added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 7, 2025
@tupui tupui temporarily deployed to github-pages October 7, 2025 19:46 — with GitHub Pages Inactive
@tupui tupui enabled auto-merge (squash) October 7, 2025 20:22
@tupui
Copy link
Member Author

tupui commented Oct 7, 2025

Deployed to https://theahaco.github.io/scaffold-stellar/

There is a readme in docs/README.md with the steps to deploy. In a follow up I am happy to add a GH action to deploy with a trigger or else.

It's fancy. The branch gh-pages only has the content of the build. This is updated automagically with bun run deploy.

Copy link
Member

Choose a reason for hiding this comment

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

Should this folder be website or something to that effect? to avoid docs/docs paths?

## Installation

```bash
bun install
Copy link
Member

Choose a reason for hiding this comment

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

Does this all work with npm or do you have to use bun?

Copy link
Member

Choose a reason for hiding this comment

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

Hmm, this suggests using bun. Since the larger project(s) default to npm, could we do that?

@chadoh
Copy link
Member

chadoh commented Oct 16, 2025

Dark mode looks bad!

Captura de pantalla 2025-10-16 a la(s) 12 53 20

@tupui
Copy link
Member Author

tupui commented Oct 16, 2025

Dark mode looks bad!

Captura de pantalla 2025-10-16 a la(s) 12 53 20

Yeah for now I even removed the button to show it. We would need some art which works for both light and dark mode. I got these images from our website and did some magic to convert them to SVG. If you have good replacements I am happy to change 👍 For the Stellar one I can use the official version so this is covered.

- Video: [Intro to Scaffold Stellar](https://www.youtube.com/watch?v=559ht4K4pkM)
- Video: [Which Frontend?](https://www.youtube.com/watch?v=pz7O54Oia_w)
- Video: [Get Started Building](https://www.youtube.com/watch?v=H-M962aPuTk)
- Video: [Live Demo of Scaffold Stellar](https://www.youtube.com/watch?v=0syGaIn3ULk) 👈 Start Here
Copy link
Member

Choose a reason for hiding this comment

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

This video is 3 months old and I assume quite out-of-date by now; is it really the best place to start?

Copy link
Member Author

Choose a reason for hiding this comment

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

Now we have your video from Meridian. Maybe that's a better start? Or we wait for the tutorial videos.

Copy link
Member

Choose a reason for hiding this comment

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

Fixable later

Copy link
Member

Choose a reason for hiding this comment

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

My comment to @chadoh is that I don't want feedback on this PR to be about editing individual existing docs -- fix those in other PRs. Let's get this website up!

Copy link
Member

@pselle pselle left a comment

Choose a reason for hiding this comment

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

So close!! I have the DNS set up at scaffoldstellar.com, please update baseURL to /

edit: and the other updates too :)

But I'm excited to get this out!

@tupui
Copy link
Member Author

tupui commented Oct 16, 2025

Thank you both! I addressed the comments I think and also fixed the DNS issues 😃

@tupui
Copy link
Member Author

tupui commented Oct 16, 2025

For bun, it's just a personal preference as way faster. But npm works the same there. I can update to npm.

I will to rename the folder to website.

@pselle pselle self-requested a review October 16, 2025 19:31
Copy link
Member

@pselle pselle left a comment

Choose a reason for hiding this comment

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

:shipit:

I saw you said you'd update to npm over bun, but I looked at scaffoldstellar.com and it's looking really good imo!! still need to hide the light/dark toggle

@tupui tupui merged commit e1c77f0 into theahaco:main Oct 16, 2025
1 check passed
@stellar-scaffold stellar-scaffold bot mentioned this pull request Oct 16, 2025
@tupui tupui deleted the docs/website branch October 17, 2025 12:55
@tupui tupui self-assigned this Oct 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants