Skip to content

Commit a992142

Browse files
committed
Update developer guide landing content
1 parent e2e8e26 commit a992142

File tree

2 files changed

+25
-19
lines changed

2 files changed

+25
-19
lines changed

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

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

6-
This developer guide is automatically generated from the wiki pages at https://github.com/codenameone/CodenameOne/wiki[https://github.com/codenameone/CodenameOne/wiki].
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.
77

8-
You can edit any page within the wiki pages using AsciiDoc. Your changes might make it (after review) into the official documentation available on the web here: https://www.codenameone.com/manual/ and available as a PDF file here: https://www.codenameone.com/files/developer-guide.pdf[https://www.codenameone.com/files/developer-guide.pdf].
8+
To contribute updates, clone the repository, create a feature branch, and edit the AsciiDoc files in `docs/developer-guide`. Proposed changes are submitted as GitHub pull requests where they undergo automated and human review. 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.
99

10-
Occasionally this book is updated to the print edition available here: https://www.amazon.com/dp/1549910035
11-
12-
We also recommend that you check out the full https://www.codenameone.com/javadoc/[JavaDoc] reference for Codename One which is very complete.
13-
14-
You can download the full Codename One source code from the https://github.com/codenameone/CodenameOne/[Codename One git repository] where you can also edit the JavaDocs and submit pull requests to https://www.codenameone.com/blog/how-to-use-the-codename-one-sources.html[include new features into Codename One].
10+
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.
1511

1612
<<<
1713

docs/developer-guide/Home.asciidoc

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,26 @@
1-
# The Codename One Wiki
1+
= Codename One Developer Guide
22

3-
In this Wiki we try to maintain the Codename One Developer guide. Check it out by clicking the links on the right hand side navigation bar. Also , you can check online Kotlin courses https://skillcombo.com/topic/kotlin/[here].
3+
Welcome to the Codename One Developer Guide. This manual brings together tutorials, patterns, and reference material to help you design, build, and ship cross-platform apps with Codename One. Use the table of contents to explore the topics most relevant to your project, or follow the guide sequentially for a comprehensive tour of the toolkit.
44

5-
This is an open edit wiki, so feel free to edit everything you see in a constructive way. You can also monitor changes to the wiki https://github.com/codenameone/CodenameOne/wiki.atom[via RSS] or by using https://ifttt.com/recipes/372144-codename-one-wiki-update-to-e-mail[ifttt].
5+
== Guide at a Glance
66

7-
To learn more about Codename One check out the following resources:
7+
* *Getting Started* – Installation, project creation, and first-run walkthroughs that help you configure your environment and build your first Codename One app.
8+
* *UI & UX* – Layout managers, themes, components, and best practices for crafting responsive user interfaces across platforms.
9+
* *Application Services* – Covers data storage, networking, push notifications, native interfaces, and other platform services you can integrate.
10+
* *Deployment & Distribution* – Instructions for packaging, signing, and publishing to the major app stores alongside troubleshooting tips.
11+
* *Appendices & Reference* – Supplemental material including glossary entries, configuration tables, and advanced topics for power users.
812

9-
* https://www.codenameone.com/javadoc/index.html[JavaDocs]
10-
* https://www.codenameone.com/how-do-i.html[How Do I? - Videos Covering common usages of Codename One]
11-
* https://www.codenameone.com/blog.html[The Codename One Blog for latest news]
12-
* https://www.codenameone.com/manual/[The developer guide as it is published on the Codename One site]
13-
* https://www.codenameone.com/hello-world.html[Hello World Tutorial]
14-
* https://www.udemy.com/learn-mobile-programming-by-example-with-codename-one/[Free Udemy course covering the creation of two simple applications]
15-
* http://stackoverflow.com/tags/codenameone[Stack overflow Codename One tag]
16-
* https://www.codenameone.com/discussion-forum.html[The Codename One Discussion Forum]
13+
Each section is organized to surface conceptual explanations first, followed by practical examples and deeper dives. Cross references within the guide link related topics so you can quickly pivot between beginner-friendly introductions and advanced techniques.
14+
15+
== Recommended Resources
16+
17+
These resources complement the manual and are maintained by the Codename One team:
18+
19+
* https://www.codenameone.com/manual/[Web edition of this guide]
20+
* https://www.codenameone.com/files/developer-guide.pdf[Downloadable PDF release]
21+
* https://www.codenameone.com/javadoc/index.html[Codename One JavaDoc]
22+
* https://www.codenameone.com/how-do-i.html[How Do I? video tutorials]
23+
* https://www.codenameone.com/blog.html[Codename One blog]
24+
* https://www.codenameone.com/discussion-forum.html[Community discussion forum]
25+
26+
For questions or improvements, open an issue or submit a pull request in the https://github.com/codenameone/CodenameOne/[Codename One GitHub repository].

0 commit comments

Comments
 (0)