Skip to content
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.

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

docs: api pages improvements #55388

Closed
wants to merge 2 commits into from

Conversation

JeanMeche
Copy link
Member

@JeanMeche JeanMeche commented Apr 17, 2024

docs: improvements for API pages

  • add link for source files
  • add deprecation message for methods
  • add usage notes for methods

Fixes #55196
Fixes #52641

Demo :

* add link for source files
* add deprecation message for methods
* add usage notes for methods

Fixes angular#55196
Fixes angular#52641
Path should have a leading slash.
@angular-robot angular-robot bot added the area: docs Related to the documentation label Apr 17, 2024
@ngbot ngbot bot added this to the Backlog milestone Apr 17, 2024
@JeanMeche JeanMeche changed the title Docs/api improvements 2 docs: api pages improvements Apr 17, 2024
Copy link

Deployed adev-preview for 3d2aff8 to: https://ng-dev-previews-fw--pr-angular-angular-55388-adev-prev-el9mru6m.web.app

Note: As new commits are pushed to this pull request, this link is updated after the preview is rebuilt.

Copy link
Member

@josephperrott josephperrott left a comment

Choose a reason for hiding this comment

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

LGTM

@bencodezen
Copy link
Contributor

Thanks for adding the deprecation notice back in!

@bencodezen bencodezen added the target: minor This PR is targeted for the next minor release label Apr 18, 2024
@bencodezen
Copy link
Contributor

Going to wait for @atscott's review before setting it to merge state!

@twerske twerske added target: patch This PR is targeted for the next patch release and removed target: minor This PR is targeted for the next minor release labels Apr 18, 2024
Copy link
Contributor

@atscott atscott left a comment

Choose a reason for hiding this comment

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

🥇

@JeanMeche JeanMeche added action: merge The PR is ready for merge by the caretaker target: major This PR is targeted for the next major release and removed target: patch This PR is targeted for the next patch release labels Apr 18, 2024
@alxhub
Copy link
Member

alxhub commented Apr 19, 2024

This PR was merged into the repository by commit 4d61501.

@alxhub alxhub closed this in 1bea1fe Apr 19, 2024
alxhub pushed a commit that referenced this pull request Apr 19, 2024
Path should have a leading slash.

PR Close #55388
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators May 20, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker adev: preview area: docs Related to the documentation target: major This PR is targeted for the next major release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Not all API documentation is visible docs: Add GitHub link to API details pages
6 participants