Skip to content

Commit 1ef4e72

Browse files
committed
docs: landing page has a more professional tone
1 parent 336ad31 commit 1ef4e72

File tree

2 files changed

+22
-21
lines changed

2 files changed

+22
-21
lines changed

docs/website/data.json

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
{
22
"title": "Mr.Docs",
3-
"description": "Mr.Docs is a C++ documentation generator for your projects.",
3+
"description": "Full-fidelity C++ documentation, straight from your code.",
44
"page": {
55
"title": "Mr.Docs",
6-
"description": "Mr.Docs is a C++ documentation generator for your projects."
6+
"description": "Mr.Docs is a full-fidelity C++ documentation generator that reads your code and comments to produce precise, publish-ready reference docs."
77
},
88
"site": {
99
"url": "https://www.mrdocs.com",
1010
"github": {
1111
"url": "https://www.github.com/cppalliance/mrdocs"
12-
}
12+
},
13+
"title": "Mr.Docs"
1314
},
1415
"navbar": [
1516
{
@@ -22,26 +23,26 @@
2223
}
2324
],
2425
"banner": {
25-
"description": "No workarounds: A tool that fully understands C++",
26-
"header": "Simple code, simple documentation",
27-
"subheader": "Mr.Docs understands C++ so you can focus on keeping the code simple."
26+
"description": "Native C++ understanding. No workarounds required.",
27+
"header": "Keep the code simple. Get clear documentation.",
28+
"subheader": "Mr.Docs understands modern C++. You focus on design and maintainability."
2829
},
2930
"features": [
3031
{
3132
"title": "Single Source of Truth",
32-
"description": "Mr. Docs takes a specially formatted comment, called a Javadoc, which precedes a C++ declaration and renders it to form a reference as part of documentation."
33+
"description": "Mr.Docs turns the documentation comments that live next to your C++ declarations into authoritative reference pages. One source of truth—your code."
3334
},
3435
{
35-
"title": "It understands C++",
36-
"description": "Mr. Docs understands C++: Overload sets, private APIs, Concepts and constraints, unspecified return types, aliases, constants, SFINAE, hidden base classes, niebloids, and coroutines."
36+
"title": "Built for C++",
37+
"description": "Mr.Docs models C++ accurately: overload sets, concepts and constraints, deduced return types, aliases, constants, SFINAE, inherited and hidden members, niebloids, and more."
3738
},
3839
{
3940
"title": "Multiple output formats",
40-
"description": "Choose from multiple output formats: Asciidoc, HTML, or XML."
41+
"description": "Export to AsciiDoc, HTML, or XML - or extend it with your own generator plugins."
4142
},
4243
{
4344
"title": "Customizable",
44-
"description": "Mr. Docs is highly customizable. You can change the output format, the theme, and even the way the documentation is generated."
45+
"description": "Highly configurable: control output format and theme, tailor symbol selection, and tune generation to match your project’s standards.\n"
4546
}
4647
],
4748
"examples": [
@@ -52,12 +53,12 @@
5253
},
5354
{
5455
"title": "Boost.URL",
55-
"description": "Boost.URL multi-page Asciidoc documentation.",
56+
"description": "Boost.URL multi-page AsciiDoc documentation.",
5657
"url": "https://mrdocs.com/demos/develop/boost-url/multi/adoc/index.adoc"
5758
},
5859
{
5960
"title": "Boost.URL",
60-
"description": "Boost.URL single-page Asciidoc documentation.",
61+
"description": "Boost.URL single-page AsciiDoc documentation.",
6162
"url": "https://mrdocs.com/demos/develop/boost-url/single/adoc/reference.adoc"
6263
},
6364
{
@@ -72,36 +73,36 @@
7273
},
7374
{
7475
"title": "Boost.Scope",
75-
"description": "Boost.Scope multi-page Asciidoc documentation.",
76+
"description": "Boost.Scope multi-page AsciiDoc documentation.",
7677
"url": "https://mrdocs.com/demos/develop/boost-scope/multi/adoc/index.adoc"
7778
},
7879
{
7980
"title": "Boost.Scope",
80-
"description": "Boost.Scope single-page Asciidoc documentation.",
81+
"description": "Boost.Scope single-page AsciiDoc documentation.",
8182
"url": "https://mrdocs.com/demos/develop/boost-scope/single/adoc-asciidoc/reference.html"
8283
}
8384
],
8485
"panels": [
8586
{
86-
"description": "Mr.Docs understands C++ features such as attributes and noexcept functions.",
87+
"description": "Accurate rendering of attributes and exception specifications (e.g. [[noreturn]], noexcept).",
8788
"source": "terminate.cpp",
8889
"imageClass": "pointing",
8990
"boxClass": "box3 box-shape3 box270"
9091
},
9192
{
92-
"description": "Specially formatted comments are rendered to form a reference as part of documentation.",
93+
"description": "Documentation comments become structured reference pages—synopsis, description, parameters, and returns.",
9394
"source": "distance.cpp",
9495
"imageClass": "shouting",
9596
"boxClass": "box3 box-shape3 box0"
9697
},
9798
{
98-
"description": "Special directives are used to describe details about the symbols.",
99+
"description": "Use directives to capture semantics beyond the signature.",
99100
"source": "is_prime.cpp",
100101
"imageClass": "glasses",
101102
"boxClass": "box3 box-shape3 box90"
102103
},
103104
{
104-
"description": "It understands concepts, constraints and SFINAE.",
105+
"description": "Understands concepts, constraints, and SFINAE—rendered as you wrote them.",
105106
"source": "sqrt.cpp",
106107
"imageClass": "writing",
107108
"boxClass": "box3 box-shape3 box180"

docs/website/index.html.hbs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@
143143
<div class="container">
144144
<hgroup>
145145
<h2>More Code, Fewer Workarounds</h2>
146-
<h3>Mr.Docs let's you keep the code simple and maintainable.</h3>
146+
<h3>Mr.Docs lets you keep code simple and maintainable.</h3>
147147
</hgroup>
148148
{{#each panels}}
149149
<div class="snippet-documentation-panel">
@@ -169,7 +169,7 @@
169169
</section>
170170
<section id="star" data-theme="light">
171171
<div class="container">
172-
<p>Give us a Star on GitHub:
172+
<p>Like what you see? Star us on GitHub:
173173
<iframe src="https://ghbtns.com/github-btn.html?user=cppalliance&amp;repo=mrdocs&amp;type=star&amp;count=true&amp;size=large"
174174
frameborder="0" scrolling="0" width="160" height="30" title="GitHub"></iframe>
175175
</p>

0 commit comments

Comments
 (0)