Skip to content

Commit edf6c9c

Browse files
committed
fix: broken links and add check for that
1 parent 17e3d10 commit edf6c9c

File tree

9 files changed

+91
-58
lines changed

9 files changed

+91
-58
lines changed

.github/workflows/ci.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- main
10+
11+
jobs:
12+
ci:
13+
timeout-minutes: 10
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v4
17+
- uses: actions/setup-node@v4
18+
with:
19+
node-version: 22
20+
- name: Install
21+
run: npm ci
22+
- name: Check
23+
run: npm run check
24+
- name: audit
25+
if: (${{ success() }} || ${{ failure() }})
26+
run: npm run buld

astro.config.mjs

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,14 @@ import starlight from "@astrojs/starlight";
44
import remarkHeadingId from "remark-heading-id";
55
import tailwind from "@astrojs/tailwind";
66
import liveCode from "astro-live-code";
7-
import rehypeAstroRelativeMarkdownLinks from "astro-rehype-relative-markdown-links";
87
import react from "@astrojs/react";
8+
import starlightLinksValidator from "starlight-links-validator";
99

1010
// https://astro.build/config
1111
export default defineConfig({
1212
markdown: {
1313
// @ts-expect-error ??????
1414
remarkPlugins: [remarkHeadingId],
15-
rehypePlugins: [
16-
[
17-
rehypeAstroRelativeMarkdownLinks,
18-
{
19-
contentPath: "src/content/docs",
20-
},
21-
],
22-
],
2315
},
2416
site: "https://docs.solvro.pl",
2517
integrations: [
@@ -29,6 +21,11 @@ export default defineConfig({
2921
},
3022
}),
3123
starlight({
24+
plugins: [
25+
starlightLinksValidator({
26+
exclude: ["http://localhost:4321"],
27+
}),
28+
],
3229
defaultLocale: "pl",
3330
locales: {
3431
root: {

package-lock.json

Lines changed: 30 additions & 26 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
"scripts": {
66
"dev": "astro dev",
77
"start": "astro dev",
8-
"build": "astro check && astro build",
8+
"check": "astro check",
9+
"build": "astro build",
910
"preview": "astro preview",
1011
"astro": "astro",
1112
"format": "prettier --write .",
@@ -22,14 +23,14 @@
2223
"astro": "^4.16.16",
2324
"astro-live-code": "^0.0.4",
2425
"astro-og-canvas": "^0.5.4",
25-
"astro-rehype-relative-markdown-links": "^0.16.0",
2626
"date-fns": "^4.1.0",
2727
"date-fns-tz": "^3.2.0",
2828
"react": "^18.3.1",
2929
"react-dom": "^18.3.1",
3030
"rehype-slug-custom-id": "^2.0.0",
3131
"remark-heading-id": "^1.0.1",
3232
"sharp": "^0.32.5",
33+
"starlight-links-validator": "^0.14.1",
3334
"tailwindcss": "^3.4.15",
3435
"typescript": "^5.7.2"
3536
},

src/content/docs/guides/Adonis.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@ description: Szybki start dla tych, którzy chcą poznać Adonisa i tworzyć św
1818

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

21-
- **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)
21+
- **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)
2222
- **IDE** - środowisko do pracy z kodem. Do najpopularniejszych opcji należy Visual Studio Code i Webstorm od Jetbrains.
2323
- **TypeScript** - jest to podstawowy język wykorzystywany przez Adonisa. Bez jego znajomości ciężko cokolwiek zrobić.
2424
- **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.
2525

2626
## Instalacja
2727

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

3030
### NodeJs
3131

@@ -72,7 +72,7 @@ npm run format
7272

7373
## Deployment
7474

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

7777
## Rozszerzenia
7878

src/content/docs/guides/Prowadzenie projektów.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Po skompletowaniu zespołu zalecamy tzw. **spotkanie wizyjne** w formie dłuższ
2727

2828
### Karta projektu
2929

30-
**Karta projektu** jest podstawowym i najważniejszym dokumentem każdego projektu. Ten 1-2 stronicowy dokument zawiera wszystkie najistotniejsze informacje dotyczące przedsięwzięcia wliczając:
30+
**Karta projektu** jest podstawowym i najważniejszym dokumentem każdego projektu. Ten 1-2 stronicowy dokument zawiera wszystkie najistotniejsze informacje dotyczące przedsięwzięcia:
3131

3232
- **Nazwę projektu**
3333
- **Project Managera**
@@ -91,7 +91,7 @@ Lead jest odpowiedzialny za jego utworzenie, odpowiednie skonfigurowanie pól i
9191

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

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

9696
### Makiety UI/UX
9797

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

151151
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
152152

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

155155
## Zamknięcie lub dalsza praca
156156

src/content/docs/hello-there.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -38,30 +38,35 @@ Znając [wstępne informacje](#na-początek) o naszej dokumentacji, chcielibyśm
3838

3939
### Dla gości
4040

41-
- [Poznaj nasz zarząd](/solvro/vii_board)
42-
- [Zapoznaj się z naszą strategią](/solvro/strategy)
41+
TODO: Dla Dawida Linka od odkomentowania
42+
43+
<!-- - [Poznaj nasz zarząd](/solvro/vii_board) -->
44+
<!-- - [Zapoznaj się z naszą strategią](/solvro/strategy) -->
4345

4446
### Dla nowych członków
4547

4648
Ogólne informacje:
4749

48-
- [Zapoznaj się z naszą strategią](./solvro/strategy/)
49-
- [Kanały komunikacji](./guides/Communication%20Channels.md)
50-
- [Jak używać GitHuba?](./guides/Github.md)
51-
- [Jak prowadzimy projekty? Czego się spodziewać?](./guides/Prowadzenie%20projektów.md)
52-
- [Poznaj nasz zarząd](/solvro/vii_board)
50+
TODO: Dla Dawida Linka od odkomentowania
51+
52+
<!-- - [Zapoznaj się z naszą strategią](/solvro/strategy) -->
53+
54+
- [Kanały komunikacji](/guides/communication-channels)
55+
- [Jak używać GitHuba?](/guides/github/)
56+
- [Jak prowadzimy projekty? Czego się spodziewać?](/guides/prowadzenie-projektów)
57+
<!-- - [Poznaj nasz zarząd](/solvro/vii_board) -->
5358

5459
Poradniki technologiczne:
5560

56-
- [Web](./guides/Web%20Development/index.mdx)
57-
- [Mobile](./guides/Flutter%20(Mobile)/index.md)
61+
- [Web](/guides/web-development/)
62+
- [Mobile](/guides/flutter-mobile/)
5863

5964
### Dla starych wyjadaczy
6065

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

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

6671
---
6772

src/content/docs/how-to-write-docs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ Ewentualnie można użyć jakiegoś onlineowego edytora markdowna, np. https://s
114114
Tutaj są wszystkie tricki, które można tutaj robić: https://starlight.astro.build/guides/authoring-content/
115115

116116
:::tip
117-
Można coś takiego!
117+
Można coś takiego!
118118
:::
119119

120120
> Albo coś takiego

src/content/docs/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ _A więc zawitałeś do naszych skromnych progów i nie wiesz, co dalej? W tym d
2828

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

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

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

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

154154
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).
155155

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

158158
# Projekty
159159

160160
## Jak działamy
161161

162162
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.
163163

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

166166
## Czas wskoczyć w projekt
167167

0 commit comments

Comments
 (0)