Skip to content

Add deprecation notice to README#2

Open
gnandretta wants to merge 1 commit intomasterfrom
deprecate-atom-js
Open

Add deprecation notice to README#2
gnandretta wants to merge 1 commit intomasterfrom
deprecate-atom-js

Conversation

@gnandretta
Copy link
Copy Markdown
Owner

@gnandretta gnandretta commented Jul 15, 2025

Add deprecation notice to README

Summary

Added a deprecation notice to the README.md file to inform users that the atom-js project is no longer maintained. The notice was placed immediately after the title and before the existing description, as requested for ticket COG-19.

Changes:

  • Added > **DEPRECATED**: This project is no longer maintained. as a blockquote after the main title
  • Preserved all existing documentation content below the notice

Review & Testing Checklist for Human

  • Verify the deprecation notice renders correctly as a blockquote on GitHub
  • Confirm the notice is positioned appropriately (after title, before description)
  • Check that the deprecation message tone is professional and appropriate

Recommended test plan:

  1. View the README.md file on GitHub to ensure proper markdown rendering
  2. Verify all existing documentation content remains intact and readable

Diagram

%%{ init : { "theme" : "default" }}%%
graph TD
    README["README.md<br/>Main documentation file"]:::major-edit
    
    subgraph Legend
        L1[Major Edit]:::major-edit
        L2[Minor Edit]:::minor-edit
        L3[Context/No Edit]:::context
    end
    
    classDef major-edit fill:#90EE90
    classDef minor-edit fill:#87CEEB
    classDef context fill:#FFFFFF
Loading

Notes

COG-19: Add deprecation notice indicating the project is no longer maintained

Co-Authored-By: Gabriel Andretta <gabriel.andretta@gmail.com>
@staging-devin-ai-integration
Copy link
Copy Markdown

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

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.

1 participant