From 21cd3f177523d2500ba5ce0a3fbc6a1514fb1d5b Mon Sep 17 00:00:00 2001 From: Ayo Ayco Date: Fri, 25 Nov 2022 15:47:39 +0100 Subject: [PATCH] feat(docs, landing-page): mention turborepo and link to discord (#210) * docs: update contributing for turborepo and discord * feat(docs, landing-page): link to the new discord server --- CONTRIBUTING.md | 18 +++++++++--------- apps/docs/src/config.ts | 2 +- apps/landing-page/src/components/header.astro | 10 +++++----- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 818d0f3..2d8c95f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,7 +3,7 @@ # Hi, explorer! 🚀 Thanks for checking out the Astro Reactive Library! Welcome to a new adventure. -We are trying to build a new library of components and utilities for building reactive user interfaces with [Astro](https://astro.build). +This is a library of components and utilities for building reactive user interfaces with [Astro](https://astro.build)--a modern web framework. There's a lot of opportunity to contribute. A good start will be to understand what Astro is, and how to set up a basic Astro project. For this, the [Astro website](https://astro.build) and [documentation](https://docs.astro.build/en/getting-started/) are good places to start. @@ -11,19 +11,19 @@ There's a lot of opportunity to contribute. A good start will be to understand w Any contribution is welcome. Feel free to look around to find something that interests you. :) -Maybe add some themes to our form component? Or maybe just improve the README? - The [issues page](https://github.com/ayoayco/astro-reactive-library/issues?q=is%3Aopen+is%3Aissue+label%3A%22accepting+PRs%22) contains some ideas, but they should not limit your contribution. -If you don't find anything there, I'm happy to help you get your contribution in. +If you don't find anything there, we are happy to help you get your contribution in. -You can always [create a new issue](https://github.com/ayoayco/astro-reactive-library/issues/new/choose) for your own idea, [email me (ayo@ayco.io)](mailto:ayo@ayco.io) or message me on [Twitter (@ayoayco)](https://twitter.com/ayoayco). +You can always [create a new issue](https://github.com/ayoayco/astro-reactive-library/issues/new/choose) for your own idea, [post on our discussions](https://github.com/ayoayco/astro-reactive-library/discussions) or join our [Discord](https://discord.gg/yKyzCjNK). # The Astro Reactive Library This project aims to be a library that developers will use to create reactive UIs with Astro. -Currently, it is made up of [NPM workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces), which are node projects that share a singular root package. It is good to understand the basics of this, but basically, the project will have multiple packages (under the `packages` directory) that share a common root package information. +The project is made up of [NPM workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces), which are node projects that share a singular root package. It is good to understand the basics of this, but basically, the project will have multiple packages (under the `packages` directory) that share a common root package information. + +We are using [Turborepo](https://turbo.build/repo) as our monorepo build system. Packages: 1. [demo](https://github.com/ayoayco/astro-reactive-library/tree/main/apps/demo) in the directory `apps/demo` @@ -39,8 +39,6 @@ Packages: [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/ayoayco/astro-reactive-library.git) - - # Running locally We mainly use the `demo` app to see changes we make on the packages. Do the following to start hacking: @@ -123,7 +121,9 @@ Thank you again for your interest in contributing! 🏘️ Read our [community guidelines](https://github.com/ayoayco/astro-reactive-library/blob/main/CODE_OF_CONDUCT.md) -💬 Check the [discussion board](https://github.com/ayoayco/astro-reactive-library/discussions) for announcements or post your messages and questions +📝 Check the [discussion board](https://github.com/ayoayco/astro-reactive-library/discussions) for announcements or post your messages and questions + +💬 Hang-out with the team on our [Discord](https://discord.gg/yKyzCjNK) to share feedback, get support, or just have some laughs over memes 😅 🛠️ Create a [new issue](https://github.com/ayoayco/astro-reactive-library/issues/new/choose) for bugs found or improvement ideas diff --git a/apps/docs/src/config.ts b/apps/docs/src/config.ts index 7fb5672..1c7441c 100644 --- a/apps/docs/src/config.ts +++ b/apps/docs/src/config.ts @@ -31,7 +31,7 @@ export const KNOWN_LANGUAGE_CODES = Object.values(KNOWN_LANGUAGES); export const GITHUB_EDIT_URL = `https://github.com/ayoayco/astro-reactive-library/tree/main/apps/docs`; -export const COMMUNITY_INVITE_URL = `https://github.com/ayoayco/astro-reactive-library/discussions`; +export const COMMUNITY_INVITE_URL = `https://discord.gg/yKyzCjNK`; // See "Algolia" section of the README for more information. export const ALGOLIA = { diff --git a/apps/landing-page/src/components/header.astro b/apps/landing-page/src/components/header.astro index fb70548..d698cbd 100644 --- a/apps/landing-page/src/components/header.astro +++ b/apps/landing-page/src/components/header.astro @@ -8,11 +8,11 @@ const socials = [ url: "https://github.com/ayoayco/astro-reactive-library", icon: "fa-brands:github-alt", }, - // { - // name: "Twitter", - // url: "https://twitter.com/ayoayco", - // icon: "fa-brands:twitter", - // }, + { + name: "Discord", + url: "https://discord.gg/yKyzCjNK", + icon: "fa-brands:discord", + }, ]; ---