Skip to content

Commit f8845cc

Browse files
authored
docs: improve landing page (#68)
* docs: improve landing page * docs: add feature event publishing
1 parent cffc085 commit f8845cc

File tree

7 files changed

+67
-21
lines changed

7 files changed

+67
-21
lines changed

docs/introduction/introduction.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ sidebar_position: 10
44

55
# Introduction
66

7+
:::info
8+
Integrate Springwolf in minutes using the [Quickstart](../quickstart.mdx).
9+
:::
10+
711
## What's Springwolf
812
API Documentation is an important part of every project and product, but can be painful to maintain manually.
913
Spring Boot projects have great solutions for auto-generated documentation for REST APIs to overcome this pain (such as Springfox, or springdoc-openapi).

docs/quickstart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import CodeSpringwolfMaven from '!!raw-loader!./snippets/_springwolf_maven.xml';
99

1010
# Quickstart
1111

12-
*The following instructions are for Kafka services - but AMQP services configuration is almost same. Check out the [example project for complete examples](https://github.com/springwolf/springwolf-core/tree/master/springwolf-examples).*
12+
*The following instructions are for Kafka services - other protocols are almost the same. Check out the [example project for complete examples](https://github.com/springwolf/springwolf-core/tree/master/springwolf-examples).*
1313

1414
## 1. Add dependencies
1515

docusaurus.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
77
/** @type {import('@docusaurus/types').Config} */
88
const config = {
99
title: 'Springwolf',
10-
tagline: 'Automated documentation (and more) for async APIs built with Spring Boot',
10+
tagline: 'Automated documentation for event-driven applications built with Spring Boot',
1111
url: 'https://www.springwolf.dev/',
1212
baseUrl: '/',
1313
onBrokenLinks: 'throw',

src/components/HomepageFeatures.js

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ const FeatureList = [
1414
),
1515
},
1616
{
17-
title: 'Easy to set up',
17+
title: 'Build for Spring',
1818
description: (
1919
<>
2020
Just provide minimal configuration in <code>application.properties</code> and
@@ -23,13 +23,37 @@ const FeatureList = [
2323
),
2424
},
2525
{
26-
title: 'AsyncAPI compliant',
26+
title: 'Powered by AsyncAPI v3',
2727
description: (
2828
<>
2929
The generated documentation is compliant with the <Link to='https://www.asyncapi.com/'>AsyncAPI specification</Link>.
3030
</>
3131
),
3232
},
33+
{
34+
title: 'Optional web-ui',
35+
description: (
36+
<>
37+
Single dependency ui for API testing including event publishing.
38+
</>
39+
),
40+
},
41+
{
42+
title: 'Customizable',
43+
description: (
44+
<>
45+
Extend documentation using <code>@AsyncListener</code> and <code>@AsyncPublisher</code>.
46+
</>
47+
),
48+
},
49+
{
50+
title: 'Integrate',
51+
description: (
52+
<>
53+
Generate documentation in your CI/CD pipeline and publish to tools like <Link to="https://backstage.io">Backstage</Link>.
54+
</>
55+
),
56+
},
3357
];
3458

3559
function Feature({Svg, title, description}) {

src/pages/index.js

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,27 @@ function HomepageHeader() {
1111
return (
1212
<header className={clsx('hero hero--primary', styles.heroBanner)}>
1313
<div className="container">
14-
<img src={"img/logo_s.png"} alt={"logo"} width={"200px"} height={"200px"} />
15-
<h1 className="hero__title">{siteConfig.title}</h1>
16-
<p className="hero__subtitle">{siteConfig.tagline}</p>
14+
<h1 className={styles.heroTitle}>
15+
<img className={styles.heroLogo} src={"img/logo_s.png"} alt={"logo"} />
16+
<span>
17+
<b>Automated</b> documentation
18+
for <b>event-driven</b> applications
19+
built with <b>Spring Boot</b>
20+
</span>
21+
</h1>
22+
1723
<div className={styles.buttons}>
1824
<Link
19-
className="button button--secondary button--lg"
20-
to="https://demo.springwolf.dev/"
21-
target={"_blank"}>
22-
Live Demo
25+
className="button button--secondary button--lg"
26+
to="/docs/introduction">
27+
Get Started
2328
</Link>
2429
&nbsp;
2530
<Link
26-
className="button button--secondary button--lg"
27-
to="/docs/quickstart">
28-
Springwolf Quickstart - 5min ⏱️
31+
className="button button--secondary button--lg"
32+
to="https://demo.springwolf.dev/"
33+
target={"_blank"}>
34+
Try a Demo
2935
</Link>
3036
</div>
3137
</div>

src/pages/index.module.css

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,21 @@
1010
overflow: hidden;
1111
}
1212

13+
.heroTitle {
14+
font-size: 3rem;
15+
font-weight: 700;
16+
margin-bottom: 2rem;
17+
}
18+
19+
.heroTitle b {
20+
color: var(--ifm-color-primary-contrast-foreground);
21+
}
22+
23+
.heroLogo {
24+
float: right;
25+
height: auto;
26+
}
27+
1328
@media screen and (max-width: 966px) {
1429
.heroBanner {
1530
padding: 2rem;
@@ -21,3 +36,7 @@
2136
align-items: center;
2237
justify-content: center;
2338
}
39+
.buttons a {
40+
margin: 0 0.5rem;
41+
--ifm-button-size-multiplier: 1.5;
42+
}

src/pages/markdown-page.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)