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

ライティングのリンク切れ修正と、リンク切れへの対策 #1483

Merged
merged 4 commits into from
Jan 15, 2025

Conversation

kuvanov-2
Copy link
Contributor

@kuvanov-2 kuvanov-2 commented Jan 6, 2025

課題・背景

  • ライティング内の構成変更にともなうリンク切れが発生しているので直したい
  • 見出しの順番等が変更されてもリンク切れが起こらないようにしたい
    https://smarthr.atlassian.net/browse/SD-960

やったこと

  • ライティング内の主要な見出しにアンカー用の{<a id="hoge" />}を追加した
  • リンク切れを修正した

やらなかったこと

  • ライティング内以外の修正やリンクチェック

動作確認

  • Previewでみてリンクが動作するかチェック

Copy link

netlify bot commented Jan 6, 2025

Deploy Preview for smarthr-design-system ready!

Name Link
🔨 Latest commit 647ed1e
🔍 Latest deploy log https://app.netlify.com/sites/smarthr-design-system/deploys/677ce1a1403cd900088c7683
😎 Deploy Preview https://deploy-preview-1483--smarthr-design-system.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@kuvanov-2 kuvanov-2 marked this pull request as ready for review January 7, 2025 00:35
Copy link
Contributor

@versionfive versionfive left a comment

Choose a reason for hiding this comment

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

アンカー先のidを指定したい場合、aタグである必要はある感じですかね?<span id="hoge" />では代用できないのでしょうか

Comment on lines 16 to 20
1. [質問(タイトル)](#question-title)
2. [リード](#lead-section)
3. [原因(見出し)](#cause-heading)
4. [説明](#explanation)
5. [対処方法](#solution)
Copy link
Contributor

@versionfive versionfive Jan 7, 2025

Choose a reason for hiding this comment

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

今回の対応の意図をあまり把握していないの的外れかもしれませんが、ここなどページ内リンクの目的であれば他のプロダクトのコンテンツ同様にh3-nでリンクするのでは問題があるのでしょうか?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ChatGPTに見出しへのアンカー設定をお願いしたら、ご丁寧にページ内リンクについても設定しなおしてくれた
→ 見出しの順番が変われば機能しなくなるというのはページ内リンクでも同様なので、提案をそのまま通した
という経緯になります!

Copy link
Contributor

Choose a reason for hiding this comment

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

デザインパターンなど他のページでその形を取っているので、特になんども修正したり、その見出しを固定のリンクとして何度も参照したいなどのUIテキストのガイドラインのようなニーズがなければ不要な気がしました。

例:https://smarthr.design/products/design-patterns/smarthr-table/

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ありがとうございます、承知です! ページ内リンクは元に戻しました 🙏

@kuvanov-2
Copy link
Contributor Author

アンカー先のidを指定したい場合、aタグである必要はある感じですかね?<span id="hoge" />では代用できないのでしょうか

たしかに<span>のほうがよい気がしたので、修正します!

@kuvanov-2 kuvanov-2 requested a review from versionfive January 7, 2025 08:13
Copy link
Contributor

@versionfive versionfive left a comment

Choose a reason for hiding this comment

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

私のコメントした部分についてはLGTMですー

@kuvanov-2 kuvanov-2 merged commit 7c4a345 into main Jan 15, 2025
5 checks passed
@kuvanov-2 kuvanov-2 deleted the SD-960-B branch January 15, 2025 01:40
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.

2 participants