Skip to content

Commit 7beaad1

Browse files
shai-almogCopilot
andauthored
Fixed developer guide warnings from vale and cleaned up (#4740)
* Fixed developer guide warnings from vale and cleaned up * Fixed replace of we to you that was a bit overzealos Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com> * Fixed extensions which were incorrect Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com> * Fixed overzealos you have from you've Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com> * Additional extension fix Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com> * Replaced this with that's incorrectly Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com> * Fixed typo Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com> * You've to you have Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com> --------- Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent cbab6b9 commit 7beaad1

55 files changed

Lines changed: 3329 additions & 3291 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/developer-guide/About-This-Guide.asciidoc

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,19 @@ toc::[]
33
[preface]
44
== Preface
55

6-
This developer guide is sourced directly from the `docs` directory of the https://github.com/codenameone/CodenameOne/[Codename One Git repository]. The documentation is written in AsciiDoc, reviewed through pull requests, and published from the main branch to multiple targets.
6+
This developer guide comes directly from the `docs` directory of the https://github.com/codenameone/CodenameOne/[Codename One Git repository]. The documentation is written in AsciiDoc, reviewed through pull requests, and published from the main branch to several targets.
77

8-
=== How to Contribute Updates
8+
=== How to contribute updates
99

10-
To contribute updates, clone the repository, create a feature branch, and edit the AsciiDoc files in `docs/developer-guide`. Follow the steps in the link:https://github.com/codenameone/CodenameOne/blob/master/CONTRIBUTING.md[CONTRIBUTING guidelines] to open a GitHub pull request (PR) instead of using the deprecated community wiki. Each PR is automatically linted and built by continuous integration, then reviewed by a maintainer before it is merged. Once merged, the content is rendered to the web manual at https://www.codenameone.com/manual/ and to the downloadable PDF at https://www.codenameone.com/files/developer-guide.pdf[https://www.codenameone.com/files/developer-guide.pdf]. Periodically, major revisions are collected for print-on-demand distribution.
10+
To contribute updates, clone the repository, create a feature branch, and edit the AsciiDoc files in `docs/developer-guide`. Follow the steps in the link:https://github.com/codenameone/CodenameOne/blob/master/CONTRIBUTING.md[CONTRIBUTING guidelines] to open a GitHub pull request (PR) instead of using the deprecated community wiki. Continuous integration lints and builds each PR automatically. A maintainer then reviews the PR before merging it. After the merge, the content appears in the web manual at https://www.codenameone.com/manual/ and in the downloadable PDF at https://www.codenameone.com/files/developer-guide.pdf[https://www.codenameone.com/files/developer-guide.pdf]. From time to time, major revisions are collected for print-on-demand distribution.
1111

12-
While this guide focuses on tutorial and conceptual material, the complete API reference remains available in the https://www.codenameone.com/javadoc/[Codename One JavaDoc]. The source code for the framework and this manual lives alongside each other in Git, so improvements to documentation and code can evolve together through the same contribution workflow.
12+
This guide focuses on tutorial and conceptual material. The complete API reference is available in the https://www.codenameone.com/javadoc/[Codename One Javadoc]. The framework source code and this manual live side by side in Git, so documentation and code improvements follow the same contribution workflow.
1313

1414
<<<
1515

1616
**Authors**
1717

18-
This document includes content from multiple authors and community wiki edits. If you edit pages within the guide feel free to add your name here alphabetized by surname:
18+
This document includes content from contributors and community wiki edits. If you edit pages in the guide, add your name here in alphabetical order by surname:
1919

2020
- https://github.com/shai-almog[Shai Almog]
2121
- https://github.com/Isborg[Ismael Baum]
@@ -28,22 +28,21 @@ This document includes content from multiple authors and community wiki edits. I
2828

2929
**Rights & Licensing**
3030

31-
You may copy/redistribute/print this document without prior permission from Codename One. However, you may not charge for the document itself although charging for costs such as printing is permitted.
31+
You may copy, redistribute, or print this document without prior permission from Codename One. You may not charge for the document itself, but charging for printing costs remains permitted.
3232

33-
Notice that while you can print and reproduce sections arbitrarily such changes must explicitly and clearly state that this is a modified copy and link to the original source at https://www.codenameone.com/manual/ in a clear way!
33+
If you print or reproduce sections and make changes, state that the result is a modified copy. Also link to the original source at https://www.codenameone.com/developer-guide/.
3434

3535
<<<<
3636

3737
**Conventions**
3838

39-
This guide uses some notations to provide tips and further guidance.
39+
This guide uses several notations for tips and further guidance.
4040

41-
In case of further information that breaks from the current tutorial
42-
flow we use a sidebar as such:
41+
When additional information breaks from the current tutorial flow, use a sidebar like this:
4342

4443
.Sidebar
4544
****
46-
Dig deeper into some details that don't quite fit into the current flow. We use sidebars for things that are an important detour, you can skip them while reading but you might want to come back and read them later.
45+
Dig deeper into details that don't quite fit the current flow. Sidebars cover important detours. You can skip them while reading and return to them later.
4746
****
4847

4948
Here are common conventions for highlighting notes:
@@ -52,18 +51,18 @@ IMPORTANT: This is an important note
5251

5352
TIP: This is a helpful tip
5453

55-
NOTE: This is a general informational note, something interesting but not crucial
54+
NOTE: This is a general informational note. It may be interesting, but it isn't crucial.
5655

57-
WARNING: This is a warning something we should pay attention to
56+
WARNING: This is a warning. Pay attention to it.
5857

59-
#This# convention is used when we refer to a button or a widget to press in the UI. E.g. press the button labeled #Press Here#.
58+
#This# convention is used when referring to a button or widget to press in the UI. For example, press the button labeled #Press Here#.
6059

61-
Quotes are presented as:
60+
Quotes appear as follows:
6261
[quote,By Author]
6362
____
6463
This is a quote
6564
____
6665

67-
*Bold* is used for light emphasis on a specific word or two within a sentence.
66+
*Bold* provides light emphasis for a specific word or two within a sentence.
6867

69-
<<<<
68+
<<<

0 commit comments

Comments
 (0)