Skip to content

👷📝 Move some internal doc inside the repo#4362

Merged
bcaudan merged 4 commits into
mainfrom
bcaudan/move-doc
Mar 24, 2026
Merged

👷📝 Move some internal doc inside the repo#4362
bcaudan merged 4 commits into
mainfrom
bcaudan/move-doc

Conversation

@bcaudan
Copy link
Copy Markdown
Collaborator

@bcaudan bcaudan commented Mar 20, 2026

Motivation

Some of our internal docs can be useful to external contributors and AI agents, let's include them inside the repository.

Changes

  • move published docs to generated-docs directory to use the docs directory for repository docs
  • migrate internal docs to the docs directory, using similar structure as electron-sdk/docs
  • combine with existing docs

Note: This PR is focused on the doc organization inside the repository, if there are some specific documentation sections to re-work let's do it on subsequent PRs.

Test instructions

  • Doc generation should work
  • Links should work
  • No mention of internal information

Checklist

  • Tested locally
  • Tested on staging
  • Added unit tests for this change.
  • Added e2e/integration tests for this change.
  • Updated documentation and/or relevant AGENTS.md file

@bcaudan bcaudan requested review from a team as code owners March 20, 2026 10:21
@datadog-prod-us1-6
Copy link
Copy Markdown

datadog-prod-us1-6 Bot commented Mar 20, 2026

✅ Tests

🎉 All green!

❄️ No new flaky tests detected
🧪 All tests passed

🎯 Code Coverage (details)
Patch Coverage: 100.00%
Overall Coverage: 77.30% (+0.01%)

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 0bd9a31 | Docs | Datadog PR Page | Was this helpful? React with 👍/👎 or give us feedback!

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: e2a300bd4d

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread package.json
@cit-pr-commenter-54b7da
Copy link
Copy Markdown

cit-pr-commenter-54b7da Bot commented Mar 20, 2026

Bundles Sizes Evolution

📦 Bundle Name Base Size Local Size 𝚫 𝚫% Status
Rum 175.02 KiB 175.02 KiB 0 B 0.00%
Rum Profiler 6.16 KiB 6.16 KiB 0 B 0.00%
Rum Recorder 27.46 KiB 27.46 KiB 0 B 0.00%
Logs 56.80 KiB 56.80 KiB 0 B 0.00%
Rum Slim 130.66 KiB 130.66 KiB 0 B 0.00%
Worker 23.63 KiB 23.63 KiB 0 B 0.00%
🚀 CPU Performance
Action Name Base CPU Time (ms) Local CPU Time (ms) 𝚫%
RUM - add global context 0.006 0.0058 -3.33%
RUM - add action 0.0186 0.0156 -16.13%
RUM - add error 0.0195 0.0165 -15.38%
RUM - add timing 0.0036 0.0044 +22.22%
RUM - start view 0.029 0.0152 -47.59%
RUM - start/stop session replay recording 0.0018 0.001 -44.44%
Logs - log message 0.0199 0.0178 -10.55%
🧠 Memory Performance
Action Name Base Memory Consumption Local Memory Consumption 𝚫
RUM - add global context 26.56 KiB 26.89 KiB +339 B
RUM - add action 51.61 KiB 51.90 KiB +295 B
RUM - add timing 27.91 KiB 26.12 KiB -1.79 KiB
RUM - add error 55.17 KiB 55.18 KiB +16 B
RUM - start/stop session replay recording 26.15 KiB 25.45 KiB -711 B
RUM - start view 466.22 KiB 462.21 KiB -4.02 KiB
Logs - log message 45.51 KiB 44.82 KiB -698 B

🔗 RealWorld

Comment thread docs/ARCHITECTURE.md
Comment thread docs/TESTING.md Outdated
Co-authored-by: Thomas Lebeau <1926949+thomas-lebeau@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@hestonhoffman hestonhoffman left a comment

Choose a reason for hiding this comment

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

Approving, but I don't think the docs team needs to review these

@bcaudan bcaudan merged commit 4c4bf0f into main Mar 24, 2026
21 checks passed
@bcaudan bcaudan deleted the bcaudan/move-doc branch March 24, 2026 09:06
@github-actions github-actions Bot locked and limited conversation to collaborators Mar 24, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants