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(docs): Add getting-started with installation #3557

Merged
merged 12 commits into from
May 24, 2024
Merged

Conversation

Fleny113
Copy link
Contributor

@Fleny113 Fleny113 commented May 9, 2024

Add a getting-started page to the docs. The getting started will include the installation and desired proprieties explanation as they tend to be very confusing at first

@Fleny113 Fleny113 self-assigned this May 9, 2024
@github-actions github-actions bot added t-feat A new feature website Affects the website w-unverified This has not been verified labels May 9, 2024
@Fleny113 Fleny113 marked this pull request as ready for review May 17, 2024 20:52
@Fleny113 Fleny113 requested a review from a team as a code owner May 17, 2024 20:52
@Fleny113 Fleny113 enabled auto-merge May 18, 2024 10:05
lts20050703
lts20050703 previously approved these changes May 18, 2024
Copy link
Member

@lts20050703 lts20050703 left a comment

Choose a reason for hiding this comment

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

LGTM!

I see that's there's a "TODO: Add a link to the page on how to use OAuth2 in Discordeno.". I think it's okay to merge this and do the TODO in a new PR.

As for "<!-- TODO: Do we want to keep this info box? Or rewrite a bit this --", I'm thinking of something like "Thank you for choosing Discordeno! Discordeno is designed to easily make scalable bots, so it might not be for you. However, we hope that you at least give it a try and don't hesitate to join and ask for help in our Discord server!"

If it sounds too "begging people" please let me know lol, I'm fine with the current text (also fine if the text was removed)

@Fleny113
Copy link
Contributor Author

I think it's okay to merge this and do the TODO in a new PR.

It would be a bit too much for one pr, i don't want to forget about it, so i added a todo, that is it

I'm thinking of something like ...

I wanted to ask because i don't know what the best solution is, discordeno does have some not completely beginner friendly things (for example Desired Proprieties or the non-exiting caching by default) but it is still valuable imho to know, and i thought it sounded too "hard"

Co-authored-by: Awesome Stickz <awesome@stickz.dev>
Co-authored-by: Awesome Stickz <awesome@stickz.dev>
website/docs/getting-started.md Outdated Show resolved Hide resolved
website/docs/getting-started.md Outdated Show resolved Hide resolved
website/docs/getting-started.md Outdated Show resolved Hide resolved
website/docs/getting-started.md Outdated Show resolved Hide resolved
website/docs/getting-started.md Outdated Show resolved Hide resolved
website/docs/getting-started.md Outdated Show resolved Hide resolved
website/docs/getting-started.md Outdated Show resolved Hide resolved
website/docs/getting-started.md Outdated Show resolved Hide resolved
website/docs/getting-started.md Outdated Show resolved Hide resolved
website/docs/intro.md Outdated Show resolved Hide resolved
Co-authored-by: Awesome Stickz <awesome@stickz.dev>
@AwesomeStickz AwesomeStickz added w-verified This had been verified and removed w-unverified This has not been verified labels May 18, 2024
@github-actions github-actions bot added the w-unverified This has not been verified label May 18, 2024
@Fleny113 Fleny113 removed the w-unverified This has not been verified label May 18, 2024
AwesomeStickz
AwesomeStickz previously approved these changes May 18, 2024
AwesomeStickz
AwesomeStickz previously approved these changes May 18, 2024
Copy link
Member

@lts20050703 lts20050703 left a comment

Choose a reason for hiding this comment

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

I'm reviewing this at 3AM so don't trust me lol, feel free to comment on any changes that doesn't make sense

website/docs/getting-started.md Outdated Show resolved Hide resolved
website/docs/getting-started.md Outdated Show resolved Hide resolved
website/docs/getting-started.md Outdated Show resolved Hide resolved
website/docs/getting-started.md Outdated Show resolved Hide resolved
website/docs/getting-started.md Outdated Show resolved Hide resolved
website/docs/getting-started.md Outdated Show resolved Hide resolved
website/docs/getting-started.md Outdated Show resolved Hide resolved
website/docs/getting-started.md Outdated Show resolved Hide resolved
website/docs/getting-started.md Outdated Show resolved Hide resolved
website/docs/getting-started.md Outdated Show resolved Hide resolved
Co-authored-by: LTS20050703 <lts20050703@gmail.com>
Copy link
Member

@lts20050703 lts20050703 left a comment

Choose a reason for hiding this comment

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

LGTM!

@Fleny113 Fleny113 added this pull request to the merge queue May 24, 2024
Merged via the queue into main with commit 8e01121 May 24, 2024
41 checks passed
@Fleny113 Fleny113 deleted the docs/getting-started branch May 24, 2024 05:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
t-feat A new feature w-verified This had been verified website Affects the website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants