Skip to content

Commit f14f1ce

Browse files
authored
docs: expand About section with website architecture details (#37242)
1 parent 07e580a commit f14f1ce

1 file changed

Lines changed: 9 additions & 4 deletions

File tree

website/README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,16 @@ https://beam.apache.org/.
2424

2525
## About
2626

27-
The Beam website is built using [Hugo](https://gohugo.io/) and the Hugo theme [Docsy](https://www.docsy.dev/). For additional formatting capabilities, this website uses [Twitter Bootstrap](https://getbootstrap.com/).
27+
The Apache Beam website is built using [Hugo](https://gohugo.io/), a fast and flexible static site generator, and uses the [Docsy](https://www.docsy.dev/) theme, which is designed specifically for technical documentation and open-source projects.
28+
29+
For additional layout, styling, and responsive design capabilities, the site integrates [Twitter Bootstrap](https://getbootstrap.com/). This allows the documentation to maintain a consistent appearance across different devices and screen sizes.
30+
31+
The website content is primarily written in Markdown and organized according to Hugo’s content structure, making it easy for contributors to add or update documentation.
32+
33+
Documentation generated directly from source code—such as **Javadoc** for Java APIs and **Pydoc** for Python APIs—is stored and maintained separately in the
34+
[beam-site repository](https://github.com/apache/beam-site/tree/release-docs).
35+
This separation ensures that API reference documentation remains versioned and consistent with official releases.
2836

29-
Documentation generated from source code, such as Javadoc and Pydoc, is stored
30-
separately on the [beam-site
31-
repository](https://github.com/apache/beam-site/tree/release-docs).
3237

3338
## Getting started
3439

0 commit comments

Comments
 (0)