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

Improve getting started documentation guide. #215

Merged
merged 2 commits into from
Apr 3, 2025

Conversation

hellsworth
Copy link
Contributor

I've moved the original getting-started.md to a new folder that now contains a README.md. The README.md provides a high level of how to contribute, with links to existing resources.

@hellsworth hellsworth requested review from rtanglao and wsmwk April 3, 2025 17:31
@LevitatingBusinessMan
Copy link

LevitatingBusinessMan commented Apr 3, 2025

If I understand gitbook correctly these pages should switch places, right?

Because now when the userlands on the front-page, and they use the link on the front-page or the left-side menu to navigate to "Getting Started" they will end up on a page titled "Setting up a build environment". While the left-side menu drops down to show another "Getting Started" page which is where they should've landed.

So the README.md should contain the generic getting started text while the build instructions should move to getting-started/setting-up-a-build-environment.md.

However I can't actually compile the gitbook because my node version is 10 major versions too high to run gitbook-cli, so I haven't been able to test it properly.

Edit: Doesn't seem like it's possible to compile this gitbook locally at all, even with a working node version. So I can't preview it.

@hellsworth
Copy link
Contributor Author

Yeah you're absolutely right! I had the naming backwards but I've fixed it now.
Unfortunately, I also do not have a way to preview this.. so I hate to test in production but let's merge it. If it's terrible, we can always revert 😅

@hellsworth hellsworth merged commit f1ce4d7 into thunderbird:master Apr 3, 2025
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