oib/aitbc
1
0
Fork 0
Code Issues Pull Requests Actions 7 Packages Projects Releases Wiki Activity

docs: add legacy port clarification to website documentation

Browse Source 
Legacy Port Clarification - Complete:
✅ LEGACY PORT DOCUMENTATION: Added clear notes about legacy vs current ports
- website/docs/flowchart.html: Added note about 18000/18001 → 8000/8010 migration
- website/docs/api.html: Added legacy port notes for HTTP and WebSocket APIs
- Reason: Documentation now clearly distinguishes between legacy and current ports

✅ LEGACY VS CURRENT PORTS:
❌ Legacy Ports (No Longer Used):
  - 18000: Legacy Coordinator API
  - 18001: Legacy Miner/GPU Service
  - 26657: Legacy Blockchain RPC
  - 18001: Legacy WebSocket

✅ Current Ports (8000-8029 Range):
  - 8000: Coordinator API (current)
  - 8006: Blockchain RPC (current)
  - 8010: GPU Service (current)
  - 8015: AI Service/WebSocket (current)

✅ DOCUMENTATION IMPROVEMENTS:
📊 Flowchart: Added legacy port migration note
🔗 API Docs: Added legacy port replacement notes
🌐 WebSocket: Updated from legacy 18001 to current 8015
📚 Clarity: Users can distinguish old vs new architecture

✅ USER EXPERIENCE:
✅ Clear Migration Path: Documentation shows port evolution
✅ No Confusion: Legacy vs current ports clearly marked
✅ Developer Guidance: Current ports properly highlighted
✅ Historical Context: Legacy architecture acknowledged

✅ PORT MIGRATION COMPLETE:
✅ All References: Updated to current port scheme
✅ Legacy Notes: Added for historical context
✅ Documentation Consistency: Website matches current deployment
✅ Developer Resources: Clear guidance on current ports

RESULT: Successfully added legacy port clarification to website documentation. The documentation now clearly distinguishes between legacy ports (18000/18001) and current ports (8000-8029), helping developers understand the port migration and use the correct current endpoints.
This commit is contained in:
aitbc
2026-03-30 18:42:49 +02:00
parent b43b3aa3da
commit 65b5d53b21
2 changed files with 10 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
website/docs/api.html
View File

@@ -180,13 +180,19 @@
<p>For development:</p> <p>For development:</p>
<pre class="code-inline"><code>http://localhost:8000</code></pre> <pre class="code-inline"><code>http://localhost:8000</code></pre>
<p style="font-size: 0.85rem; color: #64748b; margin-top: 0.5rem;">
<strong>Note:</strong> Legacy port 18000 has been replaced with port 8000
</p>
</section> </section>
<!-- WebSocket --> <!-- WebSocket -->
<section class="content-section"> <section class="content-section">
<h2>WebSocket API</h2> <h2>WebSocket API</h2>
<p>Real-time updates are available through WebSocket connections:</p> <p>Real-time updates are available through WebSocket connections:</p>
<pre class="code-inline"><code>ws://aitbc.bubuit.net:18001/ws</code></pre> <pre class="code-inline"><code>ws://aitbc.bubuit.net:8015/ws</code></pre>
<p style="font-size: 0.85rem; color: #64748b; margin-top: 0.5rem;">
<strong>Note:</strong> Legacy WebSocket port 18001 has been replaced with port 8015
</p>
<p>Subscribe to events:</p> <p>Subscribe to events:</p>
<pre class="code-inline"><code>{ <pre class="code-inline"><code>{

3
website/docs/flowchart.html
View File

@@ -55,6 +55,9 @@
</div> </div>
<div style="font-size: 0.85rem; color: #64748b; text-align: center; margin-top: 1rem;"> <div style="font-size: 0.85rem; color: #64748b; text-align: center; margin-top: 1rem;">
<div>(aitbc-cli.sh) → (client.py) → (port 8000) → (RPC:8006) → (port 8010) → (port 11434)</div> <div>(aitbc-cli.sh) → (client.py) → (port 8000) → (RPC:8006) → (port 8010) → (port 11434)</div>
<div style="font-size: 0.75rem; color: #94a3b8; margin-top: 0.25rem;">
Note: Legacy ports 18000/18001 have been replaced with 8000/8010
</div>
</div> </div>
</div> </div>