Recent

Author Topic: Laz/FPC Documentation suggestion  (Read 1652 times)

dtpfl

  • Newbie
  • Posts: 2
Laz/FPC Documentation suggestion
« on: June 07, 2021, 03:33:03 pm »
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.TJSONObject.AddPair
Lazarus
https://www.freepascal.org/docs-html/current/fcl/fpjson/tjsonobject.add.html

af0815

  • Hero Member
  • *****
  • Posts: 704
Re: Laz/FPC Documentation suggestion
« Reply #1 on: June 07, 2021, 03:46:06 pm »
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.
regards
Andreas

trev

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 1592
  • Former Delphi 1-7, 10.2 user
Re: Laz/FPC Documentation suggestion
« Reply #2 on: June 08, 2021, 03:10:53 am »
See the Wiki articles:

* JSON
* Streaming JSON
Lazarus 2.3 2021-08-10 FPC 3.3.1 r49223 macOS 10.14.6 Xcode 11.3.1
Lazarus 2.3 r65500 FPC 3.3.1 r49634 macOS 11.6 aarch64 Xcode 13
Lazarus 2.3 2021-08-11 FPC 3.2.2 FreeBSD 13.0 amd64 VMware VM
Lazarus 2.1 r61574 FPC 3.0.4 Ubuntu 20.04 Parallels VM
Lazarus 2.0.10 FPC 3.2.0 Win10 Parallels VM

avra

  • Hero Member
  • *****
  • Posts: 2231
    • Additional info
Re: Laz/FPC Documentation suggestion
« Reply #3 on: June 08, 2021, 08:06:40 am »
Imo 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
« Last Edit: June 08, 2021, 08:09:37 am by avra »
ct2laz - Conversion between Lazarus and CodeTyphon
bithelpers - Bit manipulation for standard types
pasettimino - Siemens S7 PLC lib

PascalDragon

  • Hero Member
  • *****
  • Posts: 3338
  • Compiler Developer
Re: Laz/FPC Documentation suggestion
« Reply #4 on: June 08, 2021, 09:08:56 am »
So 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.

Imo 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.

 

TinyPortal © 2005-2018