Skip to content

Commit 97a057d

Browse files
committed
feat: add getting started guide and configure MkDocs with search plugin, social links, and validation settings.
1 parent eb63802 commit 97a057d

2 files changed

Lines changed: 22 additions & 2 deletions

File tree

docs/guides/getting_started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The platform is designed as a monorepo. You should install the core and the adap
1313

1414
```bash
1515
# Clone the repository
16-
git clone https://github.com/your-org/nl2sql.git
16+
git clone https://github.com/nadeem4/nl2sql.git
1717
cd nl2sql
1818

1919
# Install Core

mkdocs.yml

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,28 @@ theme:
2626
icon:
2727
repo: fontawesome/brands/git-alt
2828

29+
30+
extra:
31+
social:
32+
- icon: fontawesome/brands/github
33+
link: https://github.com/nadeem4/nl2sql
34+
35+
copyright: Copyright © 2024 NL2SQL Contributors
36+
37+
2938
repo_url: https://github.com/nadeem4/nl2sql
30-
repo_name: nl2sql
39+
repo_name: nl2sql
40+
edit_uri: edit/main/docs/
41+
42+
# Validation settings (Strict Mode equivalent)
43+
validation:
44+
omitted_files: warn
45+
absolute_links: warn
46+
unrecognized_links: warn
47+
48+
plugins:
49+
- search
50+
3151

3252
markdown_extensions:
3353
- pymdownx.highlight:

0 commit comments

Comments
 (0)