Skip to content
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.

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

Documentation change #161

Merged
merged 1 commit into from
Jun 24, 2024
Merged

Documentation change #161

merged 1 commit into from
Jun 24, 2024

Conversation

Logofile
Copy link
Member

This change includes the following:

  • Restructures the landing page (_index.md) to simplify the layout and bring the table of contents to the left side
  • Removes the optional keyword from examples in the editions/features.md topic
  • In /editions/overview.md:
    • Clarifies that 2023 is the latest released edition
    • Adds missing package syntax from proto examples
    • Adds a reserved keyword to the proto examples to show the syntax difference between proto2/proto3 and editions
    • Corrects syntax for enums in proto examples
  • Corrects the example from the list_people command’s unit tests in getting-started/gotutorial.md
  • Replaces an outdated link to OKRs with a link to codelabs in /overview.md
  • Adds information about ruby_package to /programming-guides/dos-donts.md
  • Corrects misspellings in several topics
  • Reorganizes the content in the presence table in /programming-guides/field_presence.md
  • Corrects instances of [[] that should have been [ throughout C++ API documentation
  • Minor text changes in /cpp/arenas.md
  • Removes some outdated references to has_foo() being proto2-only in /cpp/cpp-generated.md
  • Adds information about ruby_package to /reference/ruby/ruby-generated.md
  • Removes reference to cross-domain mixing of protobuf gencode and runtime from the external docs, since it applies only internally

PiperOrigin-RevId: 644492325
Change-Id: I651afbc2d6049818a1b579b4d0e779779cb06c57

* Restructures the landing page (_index.md) to simplify the layout and bring the table of contents to the left side
* Removes the `optional` keyword from examples in the editions/features.md topic
* In /editions/overview.md:
  * Clarifies that 2023 is the latest released edition
  * Adds missing `package` syntax from proto examples
  * Adds a reserved keyword to the proto examples to show the syntax difference between proto2/proto3 and editions
  * Corrects syntax for enums in proto examples
* Corrects the example from the `list_people` command’s unit tests in getting-started/gotutorial.md
* Replaces an outdated link to OKRs with a link to codelabs in /overview.md
* Adds information about `ruby_package` to /programming-guides/dos-donts.md
* Corrects misspellings in several topics
* Reorganizes the content in the presence table in /programming-guides/field_presence.md
* Corrects instances of `[[]` that should have been `[` throughout C++ API documentation
* Minor text changes in /cpp/arenas.md
* Removes some outdated references to `has_foo()` being proto2-only in /cpp/cpp-generated.md
* Adds information about `ruby_package` to /reference/ruby/ruby-generated.md
* Removes reference to cross-domain mixing of protobuf gencode and runtime from the external docs, since it applies only internally

PiperOrigin-RevId: 644492325
Change-Id: I651afbc2d6049818a1b579b4d0e779779cb06c57
@Logofile Logofile assigned Logofile and honglooker and unassigned Logofile Jun 21, 2024
@Logofile Logofile merged commit 9b7f755 into protocolbuffers:main Jun 24, 2024
2 checks passed
@Logofile Logofile deleted the sync branch June 28, 2024 18:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants