Skip to content

Clean up and document project files #4560

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 11 commits into from
Jan 17, 2025
Merged

Clean up and document project files #4560

merged 11 commits into from
Jan 17, 2025

Conversation

nlohmann
Copy link
Owner

@nlohmann nlohmann commented Dec 18, 2024 •
edited
Loading

  • update GitHub community documents
    • update code of conduct
    • update contribution guidelines
    • update pull request template
    • update security policy
  • document non-code files in FILES.md
  • add community section to documentation
    • governance (new)
    • code of conduct (link)
    • contribution guidelines (link)
    • security policy (link)
    • quality assurance (new)
    • architecture (new, draft)
  • add DCO requirement
  • update GitHub actions
    • migrate stalebot to GitHub action
    • remove deprecated .lgtm.yml file
    • add CI steps for C++26
    • add Xcode 16.2 (macOS) and Clang 3.4 (Ubuntu) action
    • simplify Ubuntu workflow to use ubuntu-latest more often and reduce dependencies to more exotic containers
  • overwork documentation
    • remove duplicate documentation files
    • fix index file for mkdocs after merging json start/end position implementation #4517
    • update customers
    • update docset table of contents
    • overwork documentation of all serialization macros (cross references, decision table, removed redundancies)
    • fix duplicate keys in navigation (fixes Documentation for macros show wrong names #4564)
    • fix broken links
    • add documentation for start_pos and end_pos
    • add glossary
    • serve assets (fonts, CSS) locally
  • overwork README
  • overwork package manager documentation
    • add Swift Package Manager and xmake
    • add example for Conda
    • add overview with logos
    • annotate Buckaroo, CocoaPods, and wsjcpp as outdated
  • cleanup
    • remove .pre-commit-config.yml file
    • pull update for tests/thirdparty/imapdl/filterbr.py
    • move compiler flags to separate CMake files

@nlohmann nlohmann marked this pull request as draft December 18, 2024 21:56
@coveralls
Copy link

Coverage Status

coverage: 99.639%. remained the same
when pulling 8c2821a on cleanup
into 58f5f25 on develop.

@nlohmann nlohmann marked this pull request as ready for review December 20, 2024 14:42
@nlohmann nlohmann added the review needed It would be great if someone could review the proposed changes. label Dec 20, 2024
@nlohmann nlohmann mentioned this pull request Dec 21, 2024
Merged
4 tasks
@nlohmann nlohmann force-pushed the cleanup branch 4 times, most recently from 8a2a368 to 8e98561 Compare January 3, 2025 15:09
@nlohmann nlohmann mentioned this pull request Jan 3, 2025
Merged
4 tasks
nikhilreddydev
nikhilreddydev reviewed Jan 3, 2025
View reviewed changes
This was referenced Jan 4, 2025
Closed
Closed
@radistmorse radistmorse mentioned this pull request Jan 6, 2025
Open
4 tasks
@nlohmann nlohmann mentioned this pull request Jan 7, 2025
Merged
@nlohmann
🔧 clean up project
356e0ce 
Signed-off-by: Niels Lohmann <mail@nlohmann.me>
@nlohmann nlohmann mentioned this pull request Jan 8, 2025
Merged
4 tasks
@nlohmann
📝 overwork documentation
e8f7470 
Signed-off-by: Niels Lohmann <mail@nlohmann.me>
gregmarr
gregmarr reviewed Jan 8, 2025
View reviewed changes
docs/mkdocs/docs/api/macros/json_diagnostic_positions.md Outdated
was parsed using [`parse()`](../basic_json/parse.md). For all other cases,`std::string::npos` will be returned.

Note that enabling this macro increases the size of every JSON value by two `std::size_t` fields and adds slight runtime
overhead.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...overhead to parsing, copying JSON value objects, and the generation of error messages for exceptions. It also causes these values to be reported in those error messages.

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done 37bb4d9

@nlohmann
Merge branch 'develop' into cleanup
a3dcdd5
@nlohmann
📝 update documentation after merging #4590
7bf9a06 
Signed-off-by: Niels Lohmann <mail@nlohmann.me>
@nlohmann
📝 address review comments
37bb4d9 
Signed-off-by: Niels Lohmann <mail@nlohmann.me>
gregmarr
gregmarr reviewed Jan 10, 2025
View reviewed changes
@nlohmann
📝 address review comments
4bcf9a7 
Signed-off-by: Niels Lohmann <mail@nlohmann.me>
@nlohmann
🔨 adjust gcov version
eec6517 
Signed-off-by: Niels Lohmann <mail@nlohmann.me>
@nlohmann
⏪ adjust gcov version
1165433 
Signed-off-by: Niels Lohmann <mail@nlohmann.me>
@nlohmann
🙈 ignore cache
bdcfc94 
Signed-off-by: Niels Lohmann <mail@nlohmann.me>
@nlohmann
Merge branch 'develop' into cleanup
17f0065
@nlohmann
Copy link
Owner Author

@gregmarr @nikhilreddydev I would merge this branch some time tomorrow.

gregmarr
gregmarr reviewed Jan 16, 2025
View reviewed changes
@nlohmann
✏️ fix typo
8215108 
Signed-off-by: Niels Lohmann <mail@nlohmann.me>
@nlohmann nlohmann added this to the Release 3.11.4 milestone Jan 17, 2025
@nlohmann nlohmann merged commit 26cfec3 into develop Jan 17, 2025
128 checks passed
@nlohmann nlohmann deleted the cleanup branch January 17, 2025 05:53
@nlohmann nlohmann mentioned this pull request Jan 17, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nikhilreddydev nikhilreddydev nikhilreddydev left review comments

@gregmarr gregmarr gregmarr approved these changes

Assignees
No one assigned
Labels
L review needed It would be great if someone could review the proposed changes.
Projects
None yet
Milestone
Release 3.12.0
Development

Successfully merging this pull request may close these issues.

Documentation for macros show wrong names Newer serialization macros not listed in README
5 participants
@nlohmann @coveralls @codenut @gregmarr @nikhilreddydev