Skip to content

New documentation#215

Merged
FSMaxB merged 10 commits into
developfrom
new-documentation
Dec 31, 2017
Merged

New documentation#215
FSMaxB merged 10 commits into
developfrom
new-documentation

Conversation

@FSMaxB

@FSMaxB FSMaxB commented Nov 10, 2017

Copy link
Copy Markdown
Collaborator

The goal of this pull request is to rewrite the documentation in a more structured way that can also be somewhat used as a reference to look something up and contains all the gotchas.

Although the current style of "letter to the user" has its appeal, the kind of questions I have been getting over the time and that appeared on StackOverFlow make me think that a different approach should be taken.

Feel free to take a look at this work in progress and give some feedback.

@FSMaxB

FSMaxB commented Nov 10, 2017 •
edited
Loading

Copy link
Copy Markdown
Collaborator Author

TODO:

  • Explain the data structure
  • Explain parsing
  • Explain printing
  • Explain how to work with the data structure (adding/removing items to/from arrays/objects etc.)
  • Full example
  • More information about building on Windows
  • Other things

@FSMaxB FSMaxB changed the base branch from master to develop November 15, 2017 17:06
@FSMaxB FSMaxB added this to the 1.7 milestone Nov 15, 2017
@FSMaxB FSMaxB mentioned this pull request Nov 28, 2017
Closed
@FSMaxB FSMaxB force-pushed the new-documentation branch 3 times, most recently from 0233298 to 4ddb0cc Compare December 20, 2017 01:48
@PerMalmberg

PerMalmberg commented Dec 25, 2017

Copy link
Copy Markdown

This is a great improvement of the old, rather sparse, documentation.

@FSMaxB

FSMaxB commented Dec 28, 2017

Copy link
Copy Markdown
Collaborator Author

@PerMalmberg Good to hear, that's exactly what I was going for.

@FSMaxB

FSMaxB commented Dec 28, 2017

Copy link
Copy Markdown
Collaborator Author

While writing the documentation I noticed the horrible cJSON_Add macros (what Dave called "auto mode"). I intend to replace them with functions that return booleans instead of deprecating them in the documentation. (this is what is still blocking me from 1.7 at the moment.)

@PerMalmberg

PerMalmberg commented Dec 28, 2017

Copy link
Copy Markdown

@FSMaxB I'll take functions instead of macros any day. 👍

@FSMaxB FSMaxB force-pushed the new-documentation branch 3 times, most recently from 465ebea to 99c669f Compare December 30, 2017 01:25
@FSMaxB

FSMaxB commented Dec 30, 2017

Copy link
Copy Markdown
Collaborator Author

Done! Release 1.7 will probably come tomorrow or as a new years gift.

@FSMaxB FSMaxB changed the title WIP: New documentation New documentation Dec 30, 2017
@FSMaxB FSMaxB merged commit 43754e7 into develop Dec 31, 2017
@FSMaxB FSMaxB deleted the new-documentation branch February 1, 2018 00:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

enhancement user feedback wanted

Projects

None yet

Milestone

1.7

Development

Successfully merging this pull request may close these issues.

2 participants

@FSMaxB @PerMalmberg