Skip to content

Commit

Permalink
fix: broken links and add check for that
Browse files Browse the repository at this point in the history
  • Loading branch information
Rei-x committed Jan 3, 2025
1 parent 17e3d10 commit 8afa35f
Show file tree
Hide file tree
Showing 9 changed files with 90 additions and 57 deletions.
26 changes: 26 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: CI

on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
ci:
timeout-minutes: 10
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 22
- name: Install
run: npm ci
- name: Check
run: npm run check
- name: audit
if: (${{ success() }} || ${{ failure() }})
run: npm run buld
15 changes: 6 additions & 9 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,14 @@ import starlight from "@astrojs/starlight";
import remarkHeadingId from "remark-heading-id";
import tailwind from "@astrojs/tailwind";
import liveCode from "astro-live-code";
import rehypeAstroRelativeMarkdownLinks from "astro-rehype-relative-markdown-links";
import react from "@astrojs/react";
import starlightLinksValidator from "starlight-links-validator";

// https://astro.build/config
export default defineConfig({
markdown: {
// @ts-expect-error ??????
remarkPlugins: [remarkHeadingId],
rehypePlugins: [
[
rehypeAstroRelativeMarkdownLinks,
{
contentPath: "src/content/docs",
},
],
],
},
site: "https://docs.solvro.pl",
integrations: [
Expand All @@ -29,6 +21,11 @@ export default defineConfig({
},
}),
starlight({
plugins: [
starlightLinksValidator({
exclude: ["http://localhost:4321"],
}),
],
defaultLocale: "pl",
locales: {
root: {
Expand Down
56 changes: 30 additions & 26 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
"scripts": {
"dev": "astro dev",
"start": "astro dev",
"build": "astro check && astro build",
"check": "astro check",
"build": "astro build",
"preview": "astro preview",
"astro": "astro",
"format": "prettier --write .",
Expand All @@ -22,14 +23,14 @@
"astro": "^4.16.16",
"astro-live-code": "^0.0.4",
"astro-og-canvas": "^0.5.4",
"astro-rehype-relative-markdown-links": "^0.16.0",
"date-fns": "^4.1.0",
"date-fns-tz": "^3.2.0",
"react": "^18.3.1",
"react-dom": "^18.3.1",
"rehype-slug-custom-id": "^2.0.0",
"remark-heading-id": "^1.0.1",
"sharp": "^0.32.5",
"starlight-links-validator": "^0.14.1",
"tailwindcss": "^3.4.15",
"typescript": "^5.7.2"
},
Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/guides/Adonis.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ description: Szybki start dla tych, którzy chcą poznać Adonisa i tworzyć św

Oto lista najważniejszych rzeczy, które warto w mniejszym lub większym stopniu ogarniać biorąc się za naukę korzystania z Adonisa:

- **Git i GitHub** - podstawowe narzędzia pracy każdego developera. Z zasadami korzystania stosowanymi w Solvro można zapoznać się w [Handbook GitHub](./Github.md)
- **Git i GitHub** - podstawowe narzędzia pracy każdego developera. Z zasadami korzystania stosowanymi w Solvro można zapoznać się w [Handbook GitHub](/guides/github)
- **IDE** - środowisko do pracy z kodem. Do najpopularniejszych opcji należy Visual Studio Code i Webstorm od Jetbrains.
- **TypeScript** - jest to podstawowy język wykorzystywany przez Adonisa. Bez jego znajomości ciężko cokolwiek zrobić.
- **NodeJS** - technologia pozwalająca na uruchamianie JS poza przeglądarką. Wykorzystywana do budowania backendu. Zrozumienie działania importów i menadżera pakietów NPM jest potrzebne do sprawnego poruszania się po frameworku.

## Instalacja

Proces instalacji został szczegółowo przedstawiony [tutaj](https://docs.adonisjs.com/guides/getting-started/installation).
Proces instalacji został szczegółowo przedstawiony [w dokumentacji adonisa](https://docs.adonisjs.com/guides/getting-started/installation).

### NodeJs

Expand Down Expand Up @@ -72,7 +72,7 @@ npm run format

## Deployment

[Poradnik jak zdeployować apkę Adonisową](./Deployment.mdx)
[Poradnik jak zdeployować apkę Adonisową](/guides/deployment)

## Rozszerzenia

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/guides/Prowadzenie projektów.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Lead jest odpowiedzialny za jego utworzenie, odpowiednie skonfigurowanie pól i

Pamiętajmy o jak najbardziej pomocnych opisach zadań najlepiej od razu z linkami/screenami do makiety UI/UX.

Więcej informacji można znaleźć w [Handbooku Githuba](./Github.md)
Więcej informacji można znaleźć w [Handbooku Githuba](/guides/github)

### Makiety UI/UX

Expand Down Expand Up @@ -150,7 +150,7 @@ Od tego momentu przechodzimy na tzw. produkcję, gdzie reliability musi być zac

Infrastrukturą wdrożenia będzie zajmował się devops i końcowo produkcyjna aplikacja będzie hostowana na innym serwerze niż developerska. Domena aplikacji produkcyjnej jest subdomeną solvro.pl

Więcej info z deploymentu znajdziesz w [Handbooku Deploymentu](./Deployment.mdx).
Więcej info z deploymentu znajdziesz w [Handbooku Deploymentu](/guides/deployment).

## Zamknięcie lub dalsza praca

Expand Down
27 changes: 16 additions & 11 deletions src/content/docs/hello-there.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,30 +38,35 @@ Znając [wstępne informacje](#na-początek) o naszej dokumentacji, chcielibyśm

### Dla gości

- [Poznaj nasz zarząd](/solvro/vii_board)
- [Zapoznaj się z naszą strategią](/solvro/strategy)
TODO: Dla Dawida Linka od odkomentowania

<!-- - [Poznaj nasz zarząd](/solvro/vii_board) -->
<!-- - [Zapoznaj się z naszą strategią](/solvro/strategy) -->

### Dla nowych członków

Ogólne informacje:

- [Zapoznaj się z naszą strategią](./solvro/strategy/)
- [Kanały komunikacji](./guides/Communication%20Channels.md)
- [Jak używać GitHuba?](./guides/Github.md)
- [Jak prowadzimy projekty? Czego się spodziewać?](./guides/Prowadzenie%20projektów.md)
- [Poznaj nasz zarząd](/solvro/vii_board)
TODO: Dla Dawida Linka od odkomentowania

<!-- - [Zapoznaj się z naszą strategią](/solvro/strategy) -->

- [Kanały komunikacji](/guides/communication-channels)
- [Jak używać GitHuba?](/guides/github/)
- [Jak prowadzimy projekty? Czego się spodziewać?](/guides/prowadzenie-projektów)
<!-- - [Poznaj nasz zarząd](/solvro/vii_board) -->

Poradniki technologiczne:

- [Web](./guides/Web%20Development/index.mdx)
- [Mobile](./guides/Flutter%20(Mobile)/index.md)
- [Web](/guides/web-development/)
- [Mobile](/guides/flutter-mobile/)

### Dla starych wyjadaczy

Oprócz materiałów dla nowych członków, warto zapoznać się z:

- [Jak prowadzić projekt?](./guides/Prowadzenie%20projektów.md)
- [Deploy Guide](./guides/Deployment.mdx)
- [Jak prowadzić projekt?](/guides/prowadzenie-projektów/)
- [Deploy Guide](/guides/deployment/)

---

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/how-to-write-docs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ Ewentualnie można użyć jakiegoś onlineowego edytora markdowna, np. https://s
Tutaj są wszystkie tricki, które można tutaj robić: https://starlight.astro.build/guides/authoring-content/

:::tip
Można coś takiego!
Można coś takiego!
:::

> Albo coś takiego
Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ _A więc zawitałeś do naszych skromnych progów i nie wiesz, co dalej? W tym d

[Ważne zmiany 4](#ważne-zmiany)

[Jak jest obecnie 4](#jak-jest-obecnie?)
[Jak jest obecnie 4](#jak-jest-obecnie)

[**Pierwsze kroki 5**](#pierwsze-kroki)

Expand Down Expand Up @@ -153,15 +153,15 @@ Oprócz spotkań weekly całego koła odbywają się cykliczne spotkania projekt

Po restrukturyzacji kierujemy się w stronę GiTHuba. Chcemy, aby był on sercem naszej organizacji, gdzie przepływa cała praca operacyjna i kod. Tam również prowadzone są projekty od strony operacyjnej, rozpisywane zadania itd. Końcowo będąc studenckim kołem chcemy chwalić się naszymi projektami i w tym właśnie celu projekty koła, które na to pozwalają będą realizowane jako open-source. Pozwoli to uhonorować członków projektu i potwierdzić swoje doświadczenie przy szukaniu pracy. Z tego również powodu dbamy o dobre praktyki pisania kodu i pracowania z githubem (PR, jednolite commity, readme itd.). Dla początkujących na naszym blogu znajduje się post [Podstawy GITa](https://solvro.pwr.edu.pl/blog/solvro-talks-1-podstawy-gita).

Must-have lekturą jest również [Handbook Githuba](./guides/Github.md)
Must-have lekturą jest również [Handbook Githuba](/guides/github)

# Projekty

## Jak działamy

KN Solvro łączy w sobie zwinne techniki startupowe oraz solidne podejście naukowe. Oznacza to, że chcemy sprawnie realizować projekty i dążymy do jak najszybszego wypuszczenia MVP (Minimal Viable Product), ale z zachowaniem dobrych praktyk i dokumentacji projektowej.

Dokładnie jak przeprowadzić projekt w Solvro można się dowiedzieć z pomocą[Handbook prowadzenia projektów](./guides/Prowadzenie%20projektów.md)
Dokładnie jak przeprowadzić projekt w Solvro można się dowiedzieć z pomocą[Handbook prowadzenia projektów](/guides/prowadzenie-projektów/)

## Czas wskoczyć w projekt

Expand Down

0 comments on commit 8afa35f

Please sign in to comment.