Skip to content

Commit e41d4a8

Browse files
committed
Update mkdocs configuration and restructure documentation navigation; add new sections and plugins for enhanced functionality.
1 parent 412b90d commit e41d4a8

File tree

5 files changed

+70
-27
lines changed

5 files changed

+70
-27
lines changed

.github/workflows/deploy_to_pages.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@ jobs:
1212
runs-on: ubuntu-latest
1313
steps:
1414
- name: 📥 Checkout code
15-
uses: actions/checkout@v4
15+
uses: actions/checkout@v4
16+
with:
17+
fetch-depth: 0
18+
1619

1720
- name: Configure Git Credentials
1821
run: |
@@ -36,7 +39,7 @@ jobs:
3639
mkdocs-material-
3740
3841
- name: 📦 Install dependencies
39-
run: pip install mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 mkdocs-static-i18n
42+
run: pip install mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 mkdocs-git-authors-plugin mkdocs-static-i18n
4043

4144
- name: 🚀 Deploy to GitHub Pages
4245
run: mkdocs gh-deploy --force

docs/ar/design-glance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*[English](../en/README.md) ∙ [日本語](../ja/README.md) ∙ [简体中文](../zh/README.md) ∙ [繁體中文](../zh-tw/README.md) ∙ [العَرَبِيَّة‎](README.md) ∙ [বাংলা](https://github.com/donnemartin/system-design-primer/issues/220) ∙ [Português do Brasil](https://github.com/donnemartin/system-design-primer/issues/40) ∙ [Deutsch](https://github.com/donnemartin/system-design-primer/issues/186) ∙ [ελληνικά](https://github.com/donnemartin/system-design-primer/issues/130) ∙ [עברית](https://github.com/donnemartin/system-design-primer/issues/272) ∙ [Italiano](https://github.com/donnemartin/system-design-primer/issues/104) ∙ [한국어](https://github.com/donnemartin/system-design-primer/issues/102) ∙ [فارسی](https://github.com/donnemartin/system-design-primer/issues/110) ∙ [Polski](https://github.com/donnemartin/system-design-primer/issues/68) ∙ [русский язык](https://github.com/donnemartin/system-design-primer/issues/87) ∙ [Español](https://github.com/donnemartin/system-design-primer/issues/136) ∙ [ภาษาไทย](https://github.com/donnemartin/system-design-primer/issues/187) ∙ [Türkçe](https://github.com/donnemartin/system-design-primer/issues/39) ∙ [tiếng Việt](https://github.com/donnemartin/system-design-primer/issues/127) ∙ [Français](https://github.com/donnemartin/system-design-primer/issues/250) | [إضافة ترجمة](https://github.com/donnemartin/system-design-primer/issues/28)*
1+
*[English](../en/design-glance.md) ∙ [日本語](../ja/design-glance.md) ∙ [简体中文](../zh/design-glance.md) ∙ [繁體中文](../zh-tw/design-glance.md) ∙ [العَرَبِيَّة‎](design-glance.md) ∙ [বাংলা](https://github.com/donnemartin/system-design-primer/issues/220) ∙ [Português do Brasil](https://github.com/donnemartin/system-design-primer/issues/40) ∙ [Deutsch](https://github.com/donnemartin/system-design-primer/issues/186) ∙ [ελληνικά](https://github.com/donnemartin/system-design-primer/issues/130) ∙ [עברית](https://github.com/donnemartin/system-design-primer/issues/272) ∙ [Italiano](https://github.com/donnemartin/system-design-primer/issues/104) ∙ [한국어](https://github.com/donnemartin/system-design-primer/issues/102) ∙ [فارسی](https://github.com/donnemartin/system-design-primer/issues/110) ∙ [Polski](https://github.com/donnemartin/system-design-primer/issues/68) ∙ [русский язык](https://github.com/donnemartin/system-design-primer/issues/87) ∙ [Español](https://github.com/donnemartin/system-design-primer/issues/136) ∙ [ภาษาไทย](https://github.com/donnemartin/system-design-primer/issues/187) ∙ [Türkçe](https://github.com/donnemartin/system-design-primer/issues/39) ∙ [tiếng Việt](https://github.com/donnemartin/system-design-primer/issues/127) ∙ [Français](https://github.com/donnemartin/system-design-primer/issues/250) | [إضافة ترجمة](https://github.com/donnemartin/system-design-primer/issues/28)*
22

33
**ساعد في [ترجمة](TRANSLATIONS.md) هذا المستند!**
44

docs/ja/design-glance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*[English](../en/README.md) ∙ [日本語](README.md) ∙ [简体中文](../zh/README.md) ∙ [繁體中文](../zh-tw/README.md) ∙ [العَرَبِيَّة‎](../ar/README.md) ∙ [বাংলা](https://github.com/donnemartin/system-design-primer/issues/220) ∙ [Português do Brasil](https://github.com/donnemartin/system-design-primer/issues/40) ∙ [Deutsch](https://github.com/donnemartin/system-design-primer/issues/186) ∙ [ελληνικά](https://github.com/donnemartin/system-design-primer/issues/130) ∙ [עברית](https://github.com/donnemartin/system-design-primer/issues/272) ∙ [Italiano](https://github.com/donnemartin/system-design-primer/issues/104) ∙ [한국어](https://github.com/donnemartin/system-design-primer/issues/102) ∙ [فارسی](https://github.com/donnemartin/system-design-primer/issues/110) ∙ [Polski](https://github.com/donnemartin/system-design-primer/issues/68) ∙ [русский язык](https://github.com/donnemartin/system-design-primer/issues/87) ∙ [Español](https://github.com/donnemartin/system-design-primer/issues/136) ∙ [ภาษาไทย](https://github.com/donnemartin/system-design-primer/issues/187) ∙ [Türkçe](https://github.com/donnemartin/system-design-primer/issues/39) ∙ [tiếng Việt](https://github.com/donnemartin/system-design-primer/issues/127) ∙ [Français](https://github.com/donnemartin/system-design-primer/issues/250) | [Add Translation](https://github.com/donnemartin/system-design-primer/issues/28)*
1+
*[English](../en/design-glance.md) ∙ [日本語](README.md) ∙ [简体中文](../zh/design-glance.md) ∙ [繁體中文](../zh-tw/design-glance.md) ∙ [العَرَبِيَّة‎](../ar/README.md) ∙ [বাংলা](https://github.com/donnemartin/system-design-primer/issues/220) ∙ [Português do Brasil](https://github.com/donnemartin/system-design-primer/issues/40) ∙ [Deutsch](https://github.com/donnemartin/system-design-primer/issues/186) ∙ [ελληνικά](https://github.com/donnemartin/system-design-primer/issues/130) ∙ [עברית](https://github.com/donnemartin/system-design-primer/issues/272) ∙ [Italiano](https://github.com/donnemartin/system-design-primer/issues/104) ∙ [한국어](https://github.com/donnemartin/system-design-primer/issues/102) ∙ [فارسی](https://github.com/donnemartin/system-design-primer/issues/110) ∙ [Polski](https://github.com/donnemartin/system-design-primer/issues/68) ∙ [русский язык](https://github.com/donnemartin/system-design-primer/issues/87) ∙ [Español](https://github.com/donnemartin/system-design-primer/issues/136) ∙ [ภาษาไทย](https://github.com/donnemartin/system-design-primer/issues/187) ∙ [Türkçe](https://github.com/donnemartin/system-design-primer/issues/39) ∙ [tiếng Việt](https://github.com/donnemartin/system-design-primer/issues/127) ∙ [Français](https://github.com/donnemartin/system-design-primer/issues/250) | [Add Translation](https://github.com/donnemartin/system-design-primer/issues/28)*
22

33
# システム設計入門
44

docs/tr/design-glance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*[English](../en/README.md) ∙ [日本語](../ja/README.md) ∙ [简体中文](../zh/README.md) ∙ [繁體中文](../zh-tw/README.md) ∙ [العَرَبِيَّة‎](../ar/README.md) ∙ [বাংলা](https://github.com/donnemartin/system-design-primer/issues/220) ∙ [Português do Brasil](https://github.com/donnemartin/system-design-primer/issues/40) ∙ [Deutsch](https://github.com/donnemartin/system-design-primer/issues/186) ∙ [ελληνικά](https://github.com/donnemartin/system-design-primer/issues/130) ∙ [עברית](https://github.com/donnemartin/system-design-primer/issues/272) ∙ [Italiano](https://github.com/donnemartin/system-design-primer/issues/104) ∙ [한국어](https://github.com/donnemartin/system-design-primer/issues/102) ∙ [فارسی](https://github.com/donnemartin/system-design-primer/issues/110) ∙ [Polski](https://github.com/donnemartin/system-design-primer/issues/68) ∙ [русский язык](https://github.com/donnemartin/system-design-primer/issues/87) ∙ [Español](https://github.com/donnemartin/system-design-primer/issues/136) ∙ [ภาษาไทย](https://github.com/donnemartin/system-design-primer/issues/187) ∙ [Türkçe](README.md) ∙ [tiếng Việt](https://github.com/donnemartin/system-design-primer/issues/127) ∙ [Français](https://github.com/donnemartin/system-design-primer/issues/250) | [Add Translation](https://github.com/donnemartin/system-design-primer/issues/28)*
1+
*[English](../en/design-glance.md) ∙ [日本語](../ja/design-glance.md) ∙ [简体中文](../zh/design-glance.md) ∙ [繁體中文](../zh-tw/design-glance.md) ∙ [العَرَبِيَّة‎](../ar/README.md) ∙ [বাংলা](https://github.com/donnemartin/system-design-primer/issues/220) ∙ [Português do Brasil](https://github.com/donnemartin/system-design-primer/issues/40) ∙ [Deutsch](https://github.com/donnemartin/system-design-primer/issues/186) ∙ [ελληνικά](https://github.com/donnemartin/system-design-primer/issues/130) ∙ [עברית](https://github.com/donnemartin/system-design-primer/issues/272) ∙ [Italiano](https://github.com/donnemartin/system-design-primer/issues/104) ∙ [한국어](https://github.com/donnemartin/system-design-primer/issues/102) ∙ [فارسی](https://github.com/donnemartin/system-design-primer/issues/110) ∙ [Polski](https://github.com/donnemartin/system-design-primer/issues/68) ∙ [русский язык](https://github.com/donnemartin/system-design-primer/issues/87) ∙ [Español](https://github.com/donnemartin/system-design-primer/issues/136) ∙ [ภาษาไทย](https://github.com/donnemartin/system-design-primer/issues/187) ∙ [Türkçe](README.md) ∙ [tiếng Việt](https://github.com/donnemartin/system-design-primer/issues/127) ∙ [Français](https://github.com/donnemartin/system-design-primer/issues/250) | [Add Translation](https://github.com/donnemartin/system-design-primer/issues/28)*
22

33
**Bu kaynağın [çeviri](TRANSLATIONS.md)sine yardım edebirsiniz!**
44

mkdocs.yml

Lines changed: 62 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
site_name: System Design Primer Update
2-
site_url: https://ido777.github.io/system-design-primer-update/en/study_guide/
2+
site_url: https://ido777.github.io/system-design-primer-update/
33

44
repo_url: https://github.com/ido777/system-design-primer-update
55
repo_name: ido777/system-design-primer-update
@@ -62,11 +62,18 @@ plugins:
6262
enable_creation_date: true
6363
exclude:
6464
- index.md
65-
- git-committers:
66-
repository: ido777/system-design-primer-update
67-
branch: main
65+
# - git-committers:
66+
# repository: ido777/system-design-primer-update
67+
# branch: main
6868
- meta
6969
- offline
70+
- git-authors
71+
- mkdocstrings:
72+
handlers:
73+
python:
74+
paths: ["solutions/object_oriented_design"]
75+
76+
7077
# - htmlproofer
7178

7279
extra:
@@ -109,6 +116,7 @@ extra_css:
109116

110117
markdown_extensions:
111118
- admonition
119+
- pymdownx.snippets
112120
- pymdownx.superfences:
113121
custom_fences:
114122
- name: mermaid
@@ -133,26 +141,58 @@ nav:
133141
- Overview: en/index.md
134142
- Study Guide Start Here: en/study_guide.md
135143
- System Design Interview Questions: en/practice.md
136-
- System Design at a Glance: en/design-glance.md
137-
- System Design Solutions:
138-
- Pastebin: solutions/system_design/pastebin/README.md
139-
- Query Cache: solutions/system_design/query_cache/README.md
140-
- Mint: solutions/system_design/mint/README.md
141-
- Sales Rank: solutions/system_design/sales_rank/README.md
142-
- URL Shortener: solutions/system_design/url_shortener/README.md
143-
- Web Crawler: solutions/system_design/web_crawler/README.md
144-
- Scaling AWS: solutions/system_design/scaling_aws/README.md
145-
- Social Graph: solutions/system_design/social_graph/README.md
146-
- Twitter: solutions/system_design/twitter/README.md
144+
- System Design:
145+
- 'System design topics': en/sd_system_design_topics_start_here.md
146+
- 'Performance vs scalability': en/sd_performance_vs_scalability.md
147+
- 'Latency vs throughput': en/sd_latency_vs_throughput.md
148+
- 'Availability vs consistency': en/sd_availability_vs_consistency.md
149+
- 'Consistency patterns': en/sd_consistency_patterns.md
150+
- 'Availability patterns': en/sd_availability_patterns.md
151+
- 'Domain name system': en/sd_domain_name_system.md
152+
- 'Content delivery network': en/sd_content_delivery_network.md
153+
- 'Load balancer': en/sd_load_balancer.md
154+
- 'Reverse proxy (web server)': en/sd_reverse_proxy_web_server.md
155+
- 'Application layer': en/sd_application_layer.md
156+
- 'Database': en/sd_database.md
157+
- 'Cache': en/sd_cache.md
158+
- 'Asynchronism': en/sd_asynchronism.md
159+
- 'Communication': en/sd_communication.md
160+
- 'Security': en/sd_security.md
161+
- 'Appendix': en/sd_appendix.md
162+
- 'Interview preparation resources': en/sd_interview_preparation_resources.md
163+
- 'Under development': en/sd_under_development.md
164+
- 'Credits': en/sd_credits.md
165+
- 'Contact info': en/sd_contact_info.md
166+
- 'License': en/sd_license.md
167+
- Solutions:
168+
- Pastebin: solutions/system_design/pastebin/README.md
169+
- Query Cache: solutions/system_design/query_cache/README.md
170+
- Mint: solutions/system_design/mint/README.md
171+
- Sales Rank: solutions/system_design/sales_rank/README.md
172+
- URL Shortener: solutions/system_design/url_shortener/README.md
173+
- Web Crawler: solutions/system_design/web_crawler/README.md
174+
- Scaling AWS: solutions/system_design/scaling_aws/README.md
175+
- Social Graph: solutions/system_design/social_graph/README.md
176+
- Twitter: solutions/system_design/twitter/README.md
147177
- Object-Oriented Design Solutions:
148178
- Call Center: solutions/object_oriented_design/call_center/README.md
149-
- Circular Array: solutions/object_oriented_design/circular_array/README.md
150-
- Deck of Cards: solutions/object_oriented_design/deck_of_cards/README.md
151-
- Hash Table: solutions/object_oriented_design/hash_table/README.md
152-
- LRU Cache: solutions/object_oriented_design/lru_cache/README.md
153-
- Movie Tickets: solutions/object_oriented_design/movie_tickets/README.md
154-
- Online Chat: solutions/object_oriented_design/online_chat/README.md
155-
- Parking Lot: solutions/object_oriented_design/parking_lot/README.md
179+
- Circular Array: solutions/object_oriented_design/circular_array/circular_array.py
180+
- Deck of Cards: solutions/object_oriented_design/deck_of_cards/deck_of_cards.py
181+
- Hash Table: solutions/object_oriented_design/hash_table/hash_table.py
182+
- LRU Cache: solutions/object_oriented_design/lru_cache/lru_cache.py
183+
- Movie Tickets: solutions/object_oriented_design/movie_tickets/movie_tickets.py
184+
- Online Chat: solutions/object_oriented_design/online_chat/online_chat.py
185+
- Parking Lot: solutions/object_oriented_design/parking_lot/parking_lot.py
186+
- WIP (old structure and content, will be removed):
187+
- Original System Design Primer as one page (WIP): en/design-glance.md
188+
- 'Motivation': en/sd_motivation.md
189+
- 'Anki flashcards': en/sd_anki_flashcards.md
190+
- 'Contributing': en/sd_contributing.md
191+
- 'Index of system design topics': en/sd_index_of_system_design_topics.md
192+
- 'Study guide': en/sd_study_guide.md
193+
- 'How to approach a system design interview question': en/sd_how_to_approach_a_system_design_interview_question.md
194+
- 'System design interview questions with solutions': en/sd_system_design_interview_questions_with_solutions.md
195+
- 'Object-oriented design interview questions with solutions': en/sd_object-oriented_design_interview_questions_with_solutions.md
156196

157197
- Translations (Not up to date):
158198
- 简体中文 (Simplified Chinese):

0 commit comments

Comments
 (0)