Laz/FPC Documentation suggestion
lazarus / 64-FPC development

----------------------------------------------------------------------
dtpfl · 2021-06-07 13:33

Hey there!

I mainly use Delphi, but currently getting more into lazarus/fpc.
The only pain i have is the documentation. I can find the things i
search for, but it takes way more time then on Delphi.

So the question is, can i help contribute to the documentation?
Imo there is a new "documentation 2.0" necessary respectively, i would
start from scratch.

For example:

Delphi
http://docwiki.embarcadero.com/Libraries/Sydney/en/System.JSON.TJSONOb
ject.AddPair
Lazarus
https://www.freepascal.org/docs-
html/current/fcl/fpjson/tjsonobject.add.html

----------------------------------------------------------------------
af0815 · 2021-06-07 13:46

Try to understand how the actual document system works, for fpc and
Lazarus. This is not monolithic Delphi. So the ways for the
documentation is different and the wiki a major part too. Do not try
to reinvent the wheel.

----------------------------------------------------------------------
trev · 2021-06-08 01:10

See the Wiki articles:

* JSON
* Streaming JSON

----------------------------------------------------------------------
avra · 2021-06-08 06:06

Quote from: dtpfl on June 07, 2021, 03:33:03 pmImo there is a new
"documentation 2.0" necessary respectively, i would start from
scratch.You don't need to start from scratch. Depending on what you
would like to change (form or content), you might be interested in
some of these links:
https://wiki.freepascal.org/Lazarus_Docs
https://wiki.freepascal.org/How_To_Make_Lazarus_Docs
https://wiki.freepascal.org/Lazarus_Documentation_Editor
https://wiki.freepascal.org/FPDoc_Editor
https://wiki.freepascal.org/Category:Help_and_Docs
https://wiki.freepascal.org/Lazarus_Documentation

----------------------------------------------------------------------
PascalDragon · 2021-06-08 07:08

Quote from: dtpfl on June 07, 2021, 03:33:03 pmSo the question is, can
i help contribute to the documentation?
Of course! You can help improving the content of the documentation
with the links the others provided. But if you have problems with the
layout of the documentation you need to come up with concrete
improvements using the existing tools (with possible improvements) and
the existing data.

Quote from: dtpfl on June 07, 2021, 03:33:03 pmImo there is a new
"documentation 2.0" necessary respectively, i would start from
scratch.
There definitely won't be a start from scratch, cause the content of
the documentation is correct if maybe lacking. But it's a work in
progress and as said above everyone can help make it better.