Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit f5336f1

Browse files
committed
docs: fix home page — add attr_list/md_in_html extensions, clean hero, sidebar nav with Website/Community/Blog, remove stats row
1 parent 5fa1aa9 commit f5336f1

2 files changed

Lines changed: 29 additions & 17 deletions

File tree

docs/index.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,26 @@
1+
---
2+
icon: material/home
3+
---
4+
15
<div class="nx-hero" markdown>
26

7+
<img src="assets/nexus-logo-blue.png" alt="Nexus" class="nx-hero-logo" />
8+
39
# Nexus
410

511
Credential brokering for autonomous agents. Nexus sits between your agents and every third-party service they reach, managing the full credential lifecycle so your agents never hold OAuth tokens, API keys, or refresh tokens directly.
612

713
<div class="nx-cta-text" markdown>
814

9-
[Deploy in five minutes](getting-started/quickstart.md) · [Architecture](concepts/architecture.md) · [GitHub](https://github.com/Prescott-Data/nexus-framework)
15+
[Architecture](concepts/architecture.md) &nbsp;·&nbsp; [Deploy in five minutes](getting-started/quickstart.md) &nbsp;·&nbsp; [GitHub](https://github.com/Prescott-Data/nexus-framework){ target="_blank" rel="noopener" }
1016

1117
</div>
1218

1319
<div class="nx-cta" markdown>
1420

1521
[Get started](getting-started/quickstart.md){ .nx-btn .nx-btn-primary }
16-
[View on GitHub](https://github.com/Prescott-Data/nexus-framework){ .nx-btn .nx-btn-github }
17-
18-
</div>
22+
[View on GitHub](https://github.com/Prescott-Data/nexus-framework){ .nx-btn .nx-btn-github target="_blank" rel="noopener" }
1923

20-
<div class="nx-stats" markdown>
21-
<div class="nx-stat"><span class="nx-stat-value">AES-256</span><span class="nx-stat-label">Token encryption</span></div>
22-
<div class="nx-stat"><span class="nx-stat-value">4</span><span class="nx-stat-label">Core components</span></div>
23-
<div class="nx-stat"><span class="nx-stat-value">v0.4</span><span class="nx-stat-label">Current release</span></div>
24-
<div class="nx-stat"><span class="nx-stat-value">3 SDKs</span><span class="nx-stat-label">Go · TypeScript · Python</span></div>
2524
</div>
2625

2726
</div>
@@ -76,17 +75,19 @@ Broker runs on `localhost:8080`. Gateway runs on `localhost:8090`.
7675

7776
---
7877

79-
## Documentation map
78+
## Where to start
8079

81-
Read [Architecture](concepts/architecture.md) first. It establishes the control plane and data plane split, the OAuth handshake, and the credential retrieval model. Every other page assumes that mental model.
80+
Read [Architecture](concepts/architecture.md) first. It establishes the control plane and data plane split, the OAuth handshake flow, and the credential retrieval model. Every other page assumes that mental model.
8281

8382
Then follow [Deploy in Five Minutes](getting-started/quickstart.md) to run a stack and make your first connection. After that, the [Guides](guides/integrating-agents.md) cover the operational tasks you return to repeatedly.
8483

8584
---
8685

87-
## Links
86+
## Explore
8887

89-
- [GitHub repository](https://github.com/Prescott-Data/nexus-framework)
90-
- [OpenAPI spec](https://github.com/Prescott-Data/nexus-framework/blob/main/openapi.yaml)
91-
- [CHANGELOG](https://github.com/Prescott-Data/nexus-framework/blob/main/CHANGELOG.md)
92-
- [Prescott Data developer portal](https://developers.prescottdata.io)
88+
| | |
89+
|---|---|
90+
| **Source** | Browse the code, open issues, and submit PRs — [GitHub](https://github.com/Prescott-Data/nexus-framework){ target="_blank" rel="noopener" } |
91+
| **OpenAPI** | The full Gateway v1 contract — [openapi.yaml](https://github.com/Prescott-Data/nexus-framework/blob/main/openapi.yaml){ target="_blank" rel="noopener" } |
92+
| **Community** | Questions, showcases, and early feature previews — [Discord](https://discord.gg/nexus-framework){ target="_blank" rel="noopener" } |
93+
| **Blog** | Engineering deep-dives and architecture walkthroughs — [read the blog](https://developers.prescottdata.io/blog){ target="_blank" rel="noopener" } |

mkdocs.yml

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,8 @@ markdown_extensions:
6363
- pymdownx.superfences
6464
- pymdownx.highlight:
6565
anchor_linenums: true
66+
line_spans: __span
67+
pygments_lang_class: true
6668
- pymdownx.inlinehilite
6769
- pymdownx.snippets:
6870
base_path: ['.']
@@ -71,9 +73,18 @@ markdown_extensions:
7173
- tables
7274
- toc:
7375
permalink: true
76+
- attr_list
77+
- md_in_html
78+
- pymdownx.emoji:
79+
emoji_index: !!python/name:material.extensions.emoji.twemoji
80+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
7481

7582
nav:
76-
- Home: index.md
83+
- Home:
84+
- Overview: index.md
85+
- Website: https://developers.prescottdata.io
86+
- Community: https://discord.gg/nexus-framework
87+
- Blog: https://developers.prescottdata.io/blog
7788
- Concepts:
7889
- Architecture: concepts/architecture.md
7990
- Connections: concepts/connections.md

0 commit comments

Comments
 (0)