Skip to content

Update readme - #35

Merged
guanzhousongmicrosoft merged 11 commits into
documentdb:mainfrom
seesharprun:update-readme
Aug 3, 2026
Merged

Update readme#35
guanzhousongmicrosoft merged 11 commits into
documentdb:mainfrom
seesharprun:update-readme

Conversation

@seesharprun

Copy link
Copy Markdown
Contributor

Updates the readme file to give explicit contribution instructions for both articles and reference files in Markdown format.

  • Adds contribution H2 section
    • Adds API reference H3 subsection with instructions on contributing new reference content
    • Adds articles H3 subsections with instructions on contributing new articles

CopilotAI added a commit to seesharprun/documentdb-docs that referenced this pull request Dec 30, 2025
Co-authored-by: seesharprun <5067401+seesharprun@users.noreply.github.com>
@seesharprun
seesharprun marked this pull request as ready for review December 30, 2025 23:35
@seesharprun

Copy link
Copy Markdown
ContributorAuthor

@AvijitkGupta, please review this pull request deeply with your team to help refine the readme until it gives enough context for new contributors to be able to contribute successfully to this repository.

@guanzhousongmicrosoft
guanzhousongmicrosoft merged commit 7ee2895 into documentdb:mainAug 3, 2026
guanzhousongmicrosoft pushed a commit that referenced this pull request Aug 3, 2026
Two loose ends from #62, both created by pull requests that merged
independently of it and could not have known about each other.
The contributing instructions in readme.md list the folders that hold
documentation articles, and #35 wrote that list while #62 was still
open, so it names four folders where there are now five. A contributor
following it would not know the kubernetes-operator section exists or
that it follows the same rules.
The documentdb-local page had no route onward. Someone who has just run
the container and wants replication, failover, or rolling upgrades has
no reason to guess that the answer is a different section of the site;
it is the most likely place in these docs for that question to occur, so
it now points at the operator section and at the pre-built packages.
This was deliberately held back while #61 was rewriting that page, and
lands now that it has merged.
Sign up for freeto 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

@seesharprun@guanzhousongmicrosoft