Skip to content

Commit a1f41d1

Browse files
sphardysphardy
committed
Documentation Update: Ensure consistency across project
 Create Roalogic version of theme styling Add PDF download link to datasheet markdown Set LaTex layout dimensions for PDF output - recreate PDF Update IP naming for consistency Clean up markdown: * Set defaults in config.yml * Remove redundant frontmatter * Update markdown to use GitHub repo metadata - to ensure consistency Add test page for debug purposes Clean up output files Enable access to GitHub metadata
1 parent 85222eb commit a1f41d1

21 files changed

+527
-206
lines changed

‎.gitignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
.ruby-version
2-
docs/build
3-
docs/*.sh
2+
docs/tex/build
43
docs/_site

‎README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
![Roa Logic Hdr][]
22

3-
# AHB-Lite Multilayer Switch
3+
# AHB-Lite Multi-layer Interconnect Switch
44

5-
The Roa Logic *AHB-Lite Multi-layer Interconnect* is a fully parameterized High Performance, Low Latency Interconnect Fabric soft IP for AHB-Lite. It allows a virtually unlimited number of AHB-Lite bus masters and slaves to be connected without the need of bus arbitration to be implemented by the bus masters. Instead, slave side arbitration is implemented for each slave port within the core.
5+
The Roa Logic *AHB-Lite Multi-layer Interconnect Switch* is a fully parameterized High Performance, Low Latency Interconnect Fabric soft IP for AHB-Lite. It allows a virtually unlimited number of AHB-Lite bus masters and slaves to be connected without the need of bus arbitration to be implemented by the bus masters. Instead, slave side arbitration is implemented for each slave port within the core.
66

7-
The Multi-layer Interconnect supports priority and round-robin based arbitration when multiple bus masters request access to the same slave port. Arbitration typically completes within 1 clock cycle
7+
The Interconnect supports priority and round-robin based arbitration when multiple bus masters request access to the same slave port. Arbitration typically completes within 1 clock cycle
88

99
![System Diagram][]
1010

‎docs/Gemfile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
source 'https://rubygems.org'
2+
gem 'dotenv'
3+
gem 'github-pages', group: :jekyll_plugins

‎docs/_config.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
title: AHB-Lite Multi-Layer Switch
1+
title: AHB-Lite Multi-Layer Interconnect Switch
22
description: Parameterised AHB-Lite Multi-layer Interconnect Switch
33

44
theme: jekyll-theme-dinky
55
show_downloads: true
66
show_license: true
77
license: Non-Commercial License
88

9+
repository: RoaLogic/ahb3lite_interconnect
10+
911
url: https://roalogic.github.io
1012
baseurl: /ahb3lite_interconnect
1113

@@ -19,7 +21,6 @@ exclude:
1921
- "*.sh" # Ignore any scripts
2022
- "/assets/img/*.pdf" # PDF images used for PDF Datasheet
2123
- "/assets/img/*.eps" # EPS images used for PDF Datasheet
22-
- build # Temp build folder for PDF Datasheet
2324
- markdown # Markdown Datasheet generation scripts
2425
- pkg # PDF Datasheet layout definition
2526
- tex # Original source texfiles
@@ -32,5 +33,5 @@ defaults:
3233
path : ""
3334
type : pages
3435
values:
35-
layout : roalogic
36+
layout : roalogic # Use custom layout for *all* pages
3637
author : Roa Logic

‎docs/_layouts/roalogic.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ <h1 class="header">{{ site.title | default: site.github.repository_name }}</h1>
3232
</ul>
3333

3434
{% if site.show_license %}
35-
<p class="header">License Terms:<br><a class="header name" href="{{ '/LICENSE' | relative_url}}">{{ site.license }}</a></p>
35+
<p class="header">License Terms:<br><a class="header name" href="{{ '/license' | relative_url}}">{{ site.license }}</a></p>
3636
{% endif %}
3737

3838
{% if site.github.is_user_page %}
@@ -52,7 +52,6 @@ <h1 class="header">{{ site.title | default: site.github.repository_name }}</h1>
5252
</section>
5353

5454
<footer>
55-
<!--p class="logo"><a href="{{ site.github.owner_url }}"><img src="{{ 'assets/img/RoaLogicLogo.png' | relative_url}}"></a></p-->
5655
<p align=center><small>Hosted on <a href="https://pages.github.com">GitHub Pages</a></small></p>
5756
</footer>
5857

‎docs/_pages/index.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
---
2-
title: Roa Logic AHB-Lite Multilayer Switch Documentation
3-
author: Roa Logic
2+
title: Documentation
43
permalink: /
54
---
65

7-
# AHB-Lite Multilayer Switch
6+
# {{site.title}}
87

9-
The Roa Logic *AHB-Lite Multi-layer Interconnect* is a fully parameterized High Performance, Low Latency Interconnect Fabric soft IP for AHB-Lite. It allows a virtually unlimited number of AHB-Lite bus masters and slaves to be connected without the need of bus arbitration to be implemented by the bus masters. Instead, slave side arbitration is implemented for each slave port within the core.
8+
The Roa Logic *AHB-Lite Multi-layer Interconnect Switch* is a fully parameterized High Performance, Low Latency Interconnect Fabric soft IP for AHB-Lite. It allows a virtually unlimited number of AHB-Lite bus masters and slaves to be connected without the need of bus arbitration to be implemented by the bus masters. Instead, slave side arbitration is implemented for each slave port within the core.
109

1110
The Multi-layer Interconnect supports priority and round-robin based arbitration when multiple bus masters request access to the same slave port. Arbitration typically completes within 1 clock cycle
1211

@@ -39,20 +38,25 @@ Released under the RoaLogic [Non-Commercial License][NC License]
3938

4039
## Dependencies
4140

42-
This release requires the ahb3lite package found here: [https://github.com/RoaLogic/ahb3lite_pkg][ahb3lite pkg]
41+
This release requires the Roa Logic [ahb3lite package][ahb3lite pkg]
4342

4443
[^1]: The number of bus masters and slaves is physically limited by the timing requirements of the design.
4544

46-
[GitHub Pages]: https://roalogic.github.io/ahb3lite_interconnect/ "GitHub Pages Documentation"
45+
[System Diagram]: {{site.baseurl}}{% link assets/img/ahb-lite-switch-sys.png %}
46+
"Example Interconnect System"
4747

48-
[ahb3lite pkg]: https://github.com/RoaLogic/ahb3lite_pkg "ahb3lite submodule"
48+
[HTML Datasheet]: {{site.baseurl}}/{{ site.github.repository_name | append: "_datasheet.html" }}
49+
"AHB3Lite Interconnect Datasheet (HTML)"
4950

50-
[System Diagram]: {{site.baseurl}}{% link assets/img/ahb-lite-switch-sys.png %} "Example Interconnect System"
51+
[PDF Datasheet]: {{site.baseurl}}/{{site.github.repository_name | append: "_datasheet.pdf"}}
52+
"AHB3Lite Interconnect Datasheet (PDF)"
5153

52-
[HTML Datasheet]: {{site.baseurl}}{% link ahb3lite_interconnect_datasheet.md %} "AHB3Lite Interconnect Datasheet (HTML)"
54+
[NC License]: {{site.baseurl}}{% link _pages/license.md %}
55+
"Non-Commercial License"
5356

54-
[PDF Datasheet]: {{site.baseurl}}{% link ahb3lite_interconnect_datasheet.pdf %} "AHB3Lite Interconnect Datasheet (PDF)"
57+
[ReadMe]: {{site.baseurl}}{% link readme.md %}
5558

56-
[NC License]: {{site.baseurl}}{% link _pages/license.md %} "Non-Commercial License"
5759

58-
[ReadMe]: {{site.baseurl}}{% link readme.md %}
60+
[GitHub Pages]: {{site.github.url}} "GitHub Pages Documentation"
61+
62+
[ahb3lite pkg]: {{site.github.owner_url}}/ahb3lite_pkg "ahb3lite submodule"

‎docs/_pages/license.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Non-Commercial License Agreement
2+
title: License
33
permalink: /license/
44
---
55
# Non-Commercial License Agreement

‎docs/_pages/test.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Test & Debug Page
3+
permalink: /test/
4+
---
5+
# {{page.title}}
6+
7+
## GitHub Metadata Test
8+
9+
Owner: {{site.github.owner_name}}
10+
11+
Public Repos:
12+
{% for repository in site.github.public_repositories %}
13+
* [{{ repository.name }}]({{ repository.html_url }})
14+
{% endfor %}
15+
16+
---

0 commit comments

Comments
 (0)