Skip to content

DOCSP-53341: Add converted .md docs to source code repo /docs dir for community access#7910

Merged
cbullinger merged 3 commits into
realm:mainfrom
cbullinger:DOCSP-53341-add-java-sdk-docs
Sep 15, 2025
Merged

DOCSP-53341: Add converted .md docs to source code repo /docs dir for community access#7910
cbullinger merged 3 commits into
realm:mainfrom
cbullinger:DOCSP-53341-add-java-sdk-docs

Conversation

@cbullinger
Copy link
Copy Markdown
Contributor

@cbullinger cbullinger commented Sep 5, 2025

Jira: https://jira.mongodb.org/browse/DOCSP-53341 & https://jira.mongodb.org/browse/DOCSP-53526

Description

Added new docs/ dir to house the converted Java SDK docs.

  • All pages are converted fully to Markdown
  • Any references to deprecated features or products were removed (e.g. App Services and Device Sync)
  • External links were preserved
  • Links to API references were removed since they pointed to mongodb.docs domain
  • Links to MongoDB, Atlas, or other Docs pages were removed

Updated main README.md:

  • Point "Documentation" section links to new docs/ dir

Copy link
Copy Markdown
Member

@nirinchev nirinchev left a comment

Choose a reason for hiding this comment

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

Skimmed through the core concepts and it seems good to me.

Comment thread docs/README.md Outdated
Comment thread docs/README.md
Use the SDK's open-source database - Realm - as an object store on the device.

### Install the Java SDK
Use the Gradle build system to
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Don't remember the original docs website structure, but this readme seems a bit odd - like it's missing code snippets or some links.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

yeah, it's not ideal. this was originally the landing page, stripped of any links to MongoDB docs or the API ref (hosted on mdb)

Co-authored-by: Nikola Irinchev <irinchev@me.com>
@cla-bot cla-bot Bot added the cla: yes label Sep 15, 2025
@cbullinger cbullinger merged commit e5f4caa into realm:main Sep 15, 2025
2 of 4 checks passed
@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Oct 15, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants