Skip to content

docs: add AGENTS.md and mark deprecated APIs for cleanup #383

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
Aug 15, 2025
Merged

docs: add AGENTS.md and mark deprecated APIs for cleanup #383

merged 11 commits into from
Aug 15, 2025

Conversation

@maksymar
Copy link
Contributor

@maksymar maksymar commented Aug 15, 2025 •
edited
Loading

This PR improves documentation quality and add API cleanup plan.

  • Add AGENTS.md contributor guide with documentation standards
  • Document memory bucket allocation limitations in MemoryManager
  • Add TODO comments for deprecated BTreeMap methods for v1.0 cleanup

The AGENTS.md establishes quality standards for documentation and API
changes. The memory manager documentation now warns users about
permanent bucket allocation behavior that can increase storage costs.
TODO comments mark deprecated methods for removal/renaming in the next
major release.

@maksymar maksymar requested a review from Copilot August 15, 2025 08:38
@maksymar maksymar changed the title docs: add contributor guide, document memory limitations, and mark de… docs: improve documentation quality and add API cleanup plan Aug 15, 2025
Copilot

This comment was marked as outdated.

Sign in to view

@maksymar maksymar changed the title docs: improve documentation quality and add API cleanup plan docs: add AGENTS.md and mark deprecated APIs for cleanup Aug 15, 2025
@maksymar @Copilot
Update AGENTS.md
2a98e4a 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@maksymar maksymar requested a review from Copilot August 15, 2025 08:39
Copilot

This comment was marked as outdated.

Sign in to view

maksymar and others added 5 commits August 15, 2025 10:40
@maksymar
Merge branch 'maksym/agents' of github.com:dfinity/stable-structures …
01168a7 
…into maksym/agents
@maksymar @Copilot
Update src/btreemap.rs
e6a10bb 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@maksymar @Copilot
Update AGENTS.md
8796dc5 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@maksymar
.
fa7d058
@maksymar
.
9fa4380
@maksymar maksymar requested a review from Copilot August 15, 2025 08:44
Copilot
Copilot AI reviewed Aug 15, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR enhances documentation quality and establishes a cleanup plan for deprecated APIs. It adds a comprehensive contributor guide (AGENTS.md) that establishes documentation standards, documents important memory allocation limitations in the MemoryManager, and marks deprecated BTreeMap methods with TODO comments for future removal in v1.0.

  • Add AGENTS.md contributor guide with documentation standards and quality requirements
  • Document memory bucket allocation limitations and storage cost implications in MemoryManager
  • Add TODO comments to deprecated BTreeMap methods for systematic cleanup in v1.0

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
AGENTS.md New contributor guide establishing documentation standards, quality requirements, and API change processes
src/memory_manager.rs Enhanced documentation explaining bucket allocation limitations and storage cost implications
src/btreemap.rs Added TODO comments to deprecated methods for v1.0 cleanup planning

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@maksymar @Copilot
Update src/memory_manager.rs
3d98a32 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@maksymar maksymar marked this pull request as ready for review August 15, 2025 08:46
@maksymar maksymar requested a review from a team as a code owner August 15, 2025 08:46
berestovskyy
berestovskyy approved these changes Aug 15, 2025
View reviewed changes
@github-actions
Copy link

github-actions bot commented Aug 15, 2025 •
edited
Loading

canbench 🏋 (dir: ./benchmarks/memory_manager) e9c580c 2025-08-15 09:17:18 UTC

✅ ./benchmarks/memory_manager/canbench_results.yml is up to date
📦 canbench_results_memory-manager.csv available in artifacts

---------------------------------------------------

Summary:
  instructions:
    status:   No significant changes 👍
    counts:   [total 3 | regressed 0 | improved 0 | new 0 | unchanged 3]
    change:   [max 0 | p75 0 | median 0 | p25 0 | min 0]
    change %: [max 0.00% | p75 0.00% | median 0.00% | p25 0.00% | min 0.00%]

  heap_increase:
    status:   No significant changes 👍
    counts:   [total 3 | regressed 0 | improved 0 | new 0 | unchanged 3]
    change:   [max 0 | p75 0 | median 0 | p25 0 | min 0]
    change %: [max 0.00% | p75 0.00% | median 0.00% | p25 0.00% | min 0.00%]

  stable_memory_increase:
    status:   No significant changes 👍
    counts:   [total 3 | regressed 0 | improved 0 | new 0 | unchanged 3]
    change:   [max 0 | p75 0 | median 0 | p25 0 | min 0]
    change %: [max 0.00% | p75 0.00% | median 0.00% | p25 0.00% | min 0.00%]

---------------------------------------------------
CSV results saved to canbench_results.csv

@github-actions
Copy link

github-actions bot commented Aug 15, 2025 •
edited
Loading

canbench 🏋 (dir: ./benchmarks/btreemap) e9c580c 2025-08-15 09:19:13 UTC

✅ ./benchmarks/btreemap/canbench_results.yml is up to date
📦 canbench_results_btreemap.csv available in artifacts

---------------------------------------------------

Summary:
  instructions:
    status:   No significant changes 👍
    counts:   [total 303 | regressed 0 | improved 0 | new 0 | unchanged 303]
    change:   [max 0 | p75 0 | median 0 | p25 0 | min 0]
    change %: [max 0.00% | p75 0.00% | median 0.00% | p25 0.00% | min 0.00%]

  heap_increase:
    status:   No significant changes 👍
    counts:   [total 303 | regressed 0 | improved 0 | new 0 | unchanged 303]
    change:   [max 0 | p75 0 | median 0 | p25 0 | min 0]
    change %: [max 0.00% | p75 0.00% | median 0.00% | p25 0.00% | min 0.00%]

  stable_memory_increase:
    status:   No significant changes 👍
    counts:   [total 303 | regressed 0 | improved 0 | new 0 | unchanged 303]
    change:   [max 0 | p75 0 | median 0 | p25 0 | min 0]
    change %: [max 0.00% | p75 0.00% | median 0.00% | p25 0.00% | min 0.00%]

---------------------------------------------------
CSV results saved to canbench_results.csv

@github-actions
Copy link

github-actions bot commented Aug 15, 2025 •
edited
Loading

canbench 🏋 (dir: ./benchmarks/btreeset) e9c580c 2025-08-15 09:17:41 UTC

✅ ./benchmarks/btreeset/canbench_results.yml is up to date
📦 canbench_results_btreeset.csv available in artifacts

---------------------------------------------------

Summary:
  instructions:
    status:   No significant changes 👍
    counts:   [total 100 | regressed 0 | improved 0 | new 0 | unchanged 100]
    change:   [max 0 | p75 0 | median 0 | p25 0 | min 0]
    change %: [max 0.00% | p75 0.00% | median 0.00% | p25 0.00% | min 0.00%]

  heap_increase:
    status:   No significant changes 👍
    counts:   [total 100 | regressed 0 | improved 0 | new 0 | unchanged 100]
    change:   [max 0 | p75 0 | median 0 | p25 0 | min 0]
    change %: [max 0.00% | p75 0.00% | median 0.00% | p25 0.00% | min 0.00%]

  stable_memory_increase:
    status:   No significant changes 👍
    counts:   [total 100 | regressed 0 | improved 0 | new 0 | unchanged 100]
    change:   [max 0 | p75 0 | median 0 | p25 0 | min 0]
    change %: [max 0.00% | p75 0.00% | median 0.00% | p25 0.00% | min 0.00%]

---------------------------------------------------
CSV results saved to canbench_results.csv

@github-actions
Copy link

github-actions bot commented Aug 15, 2025 •
edited
Loading

canbench 🏋 (dir: ./benchmarks/vec) e9c580c 2025-08-15 09:17:23 UTC

✅ ./benchmarks/vec/canbench_results.yml is up to date
📦 canbench_results_vec.csv available in artifacts

---------------------------------------------------

Summary:
  instructions:
    status:   No significant changes 👍
    counts:   [total 16 | regressed 0 | improved 0 | new 0 | unchanged 16]
    change:   [max 0 | p75 0 | median 0 | p25 0 | min 0]
    change %: [max 0.00% | p75 0.00% | median 0.00% | p25 0.00% | min 0.00%]

  heap_increase:
    status:   No significant changes 👍
    counts:   [total 16 | regressed 0 | improved 0 | new 0 | unchanged 16]
    change:   [max 0 | p75 0 | median 0 | p25 0 | min 0]
    change %: [max 0.00% | p75 0.00% | median 0.00% | p25 0.00% | min 0.00%]

  stable_memory_increase:
    status:   No significant changes 👍
    counts:   [total 16 | regressed 0 | improved 0 | new 0 | unchanged 16]
    change:   [max 0 | p75 0 | median 0 | p25 0 | min 0]
    change %: [max 0.00% | p75 0.00% | median 0.00% | p25 0.00% | min 0.00%]

---------------------------------------------------
CSV results saved to canbench_results.csv

@github-actions
Copy link

github-actions bot commented Aug 15, 2025 •
edited
Loading

canbench 🏋 (dir: ./benchmarks/nns) e9c580c 2025-08-15 09:17:25 UTC

✅ ./benchmarks/nns/canbench_results.yml is up to date
📦 canbench_results_nns.csv available in artifacts

---------------------------------------------------

Summary:
  instructions:
    status:   No significant changes 👍
    counts:   [total 16 | regressed 0 | improved 0 | new 0 | unchanged 16]
    change:   [max 0 | p75 0 | median -98 | p25 -439.05K | min -6.98M]
    change %: [max 0.00% | p75 0.00% | median -0.04% | p25 -0.16% | min -0.29%]

  heap_increase:
    status:   No significant changes 👍
    counts:   [total 16 | regressed 0 | improved 0 | new 0 | unchanged 16]
    change:   [max 0 | p75 0 | median 0 | p25 0 | min 0]
    change %: [max 0.00% | p75 0.00% | median 0.00% | p25 0.00% | min 0.00%]

  stable_memory_increase:
    status:   No significant changes 👍
    counts:   [total 16 | regressed 0 | improved 0 | new 0 | unchanged 16]
    change:   [max 0 | p75 0 | median 0 | p25 0 | min 0]
    change %: [max 0.00% | p75 0.00% | median 0.00% | p25 0.00% | min 0.00%]

---------------------------------------------------
CSV results saved to canbench_results.csv

@github-actions
Copy link

github-actions bot commented Aug 15, 2025 •
edited
Loading

canbench 🏋 (dir: ./benchmarks/io_chunks) e9c580c 2025-08-15 09:18:12 UTC

✅ ./benchmarks/io_chunks/canbench_results.yml is up to date
📦 canbench_results_io_chunks.csv available in artifacts

---------------------------------------------------

Summary:
  instructions:
    status:   No significant changes 👍
    counts:   [total 18 | regressed 0 | improved 0 | new 0 | unchanged 18]
    change:   [max 0 | p75 0 | median 0 | p25 0 | min 0]
    change %: [max 0.00% | p75 0.00% | median 0.00% | p25 0.00% | min 0.00%]

  heap_increase:
    status:   No significant changes 👍
    counts:   [total 18 | regressed 0 | improved 0 | new 0 | unchanged 18]
    change:   [max 0 | p75 0 | median 0 | p25 0 | min 0]
    change %: [max 0.00% | p75 0.00% | median 0.00% | p25 0.00% | min 0.00%]

  stable_memory_increase:
    status:   No significant changes 👍
    counts:   [total 18 | regressed 0 | improved 0 | new 0 | unchanged 18]
    change:   [max 0 | p75 0 | median 0 | p25 0 | min 0]
    change %: [max 0.00% | p75 0.00% | median 0.00% | p25 0.00% | min 0.00%]

---------------------------------------------------
CSV results saved to canbench_results.csv

@maksymar maksymar enabled auto-merge (squash) August 15, 2025 09:02
@maksymar maksymar merged commit c3c3c72 into main Aug 15, 2025
16 checks passed
@maksymar maksymar deleted the maksym/agents branch August 15, 2025 09:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@berestovskyy berestovskyy berestovskyy approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@maksymar @berestovskyy