Skip to content

Commit

Permalink
docs: improve landing page (springwolf#68)
Browse files Browse the repository at this point in the history
* docs: improve landing page

* docs: add feature event publishing
  • Loading branch information
timonback authored Feb 23, 2024
1 parent cffc085 commit f8845cc
Show file tree
Hide file tree
Showing 7 changed files with 67 additions and 21 deletions.
4 changes: 4 additions & 0 deletions docs/introduction/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ sidebar_position: 10

# Introduction

:::info
Integrate Springwolf in minutes using the [Quickstart](../quickstart.mdx).
:::

## What's Springwolf
API Documentation is an important part of every project and product, but can be painful to maintain manually.
Spring Boot projects have great solutions for auto-generated documentation for REST APIs to overcome this pain (such as Springfox, or springdoc-openapi).
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import CodeSpringwolfMaven from '!!raw-loader!./snippets/_springwolf_maven.xml';

# Quickstart

*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).*
*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).*

## 1. Add dependencies

Expand Down
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'Springwolf',
tagline: 'Automated documentation (and more) for async APIs built with Spring Boot',
tagline: 'Automated documentation for event-driven applications built with Spring Boot',
url: 'https://www.springwolf.dev/',
baseUrl: '/',
onBrokenLinks: 'throw',
Expand Down
28 changes: 26 additions & 2 deletions src/components/HomepageFeatures.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ const FeatureList = [
),
},
{
title: 'Easy to set up',
title: 'Build for Spring',
description: (
<>
Just provide minimal configuration in <code>application.properties</code> and
Expand All @@ -23,13 +23,37 @@ const FeatureList = [
),
},
{
title: 'AsyncAPI compliant',
title: 'Powered by AsyncAPI v3',
description: (
<>
The generated documentation is compliant with the <Link to='https://www.asyncapi.com/'>AsyncAPI specification</Link>.
</>
),
},
{
title: 'Optional web-ui',
description: (
<>
Single dependency ui for API testing including event publishing.
</>
),
},
{
title: 'Customizable',
description: (
<>
Extend documentation using <code>@AsyncListener</code> and <code>@AsyncPublisher</code>.
</>
),
},
{
title: 'Integrate',
description: (
<>
Generate documentation in your CI/CD pipeline and publish to tools like <Link to="https://backstage.io">Backstage</Link>.
</>
),
},
];

function Feature({Svg, title, description}) {
Expand Down
26 changes: 16 additions & 10 deletions src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,27 @@ function HomepageHeader() {
return (
<header className={clsx('hero hero--primary', styles.heroBanner)}>
<div className="container">
<img src={"img/logo_s.png"} alt={"logo"} width={"200px"} height={"200px"} />
<h1 className="hero__title">{siteConfig.title}</h1>
<p className="hero__subtitle">{siteConfig.tagline}</p>
<h1 className={styles.heroTitle}>
<img className={styles.heroLogo} src={"img/logo_s.png"} alt={"logo"} />
<span>
<b>Automated</b> documentation
for <b>event-driven</b> applications
built with <b>Spring Boot</b>
</span>
</h1>

<div className={styles.buttons}>
<Link
className="button button--secondary button--lg"
to="https://demo.springwolf.dev/"
target={"_blank"}>
Live Demo
className="button button--secondary button--lg"
to="/docs/introduction">
Get Started
</Link>
&nbsp;
<Link
className="button button--secondary button--lg"
to="/docs/quickstart">
Springwolf Quickstart - 5min ⏱️
className="button button--secondary button--lg"
to="https://demo.springwolf.dev/"
target={"_blank"}>
Try a Demo
</Link>
</div>
</div>
Expand Down
19 changes: 19 additions & 0 deletions src/pages/index.module.css
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,21 @@
overflow: hidden;
}

.heroTitle {
font-size: 3rem;
font-weight: 700;
margin-bottom: 2rem;
}

.heroTitle b {
color: var(--ifm-color-primary-contrast-foreground);
}

.heroLogo {
float: right;
height: auto;
}

@media screen and (max-width: 966px) {
.heroBanner {
padding: 2rem;
Expand All @@ -21,3 +36,7 @@
align-items: center;
justify-content: center;
}
.buttons a {
margin: 0 0.5rem;
--ifm-button-size-multiplier: 1.5;
}
7 changes: 0 additions & 7 deletions src/pages/markdown-page.md

This file was deleted.

0 comments on commit f8845cc

Please sign in to comment.