새로운 사이드바를 통한 더 나은 문서 내비게이션

[hugh (Hugh Lashbrooke)]

이번 주에 Discourse 문서에 중요한 개선 사항인 새 사이드바를 공개했습니다. 이 기능은 문서 탐색과 접근을 이전보다 훨씬 쉽고 직관적으로 만들기 위해 설계되었습니다.

무엇이 새로워졌나요?

새로운 사이드바는 모든 문서 카테고리 및 토픽에 표시되어 콘텐츠 탐색을 용이하게 합니다. 다음과 같은 기능을 기대할 수 있습니다:

1. 개선된 탐색: 명확한 계층 구조를 통해 서로 다른 토픽 간 이동이 이제 더 빠르고 직관적입니다.

2. 맥락 인식: 사이드바는 현재 보고 있는 토픽을 강조 표시하여 문서 내에서 어디에 있는지 쉽게 파악할 수 있도록 합니다.

3. 접기/펼치기 가능한 섹션: 사이드바의 각 섹션은 필요에 따라 접거나 펼칠 수 있어 필요한 토픽을 찾는 것이 더 쉬워집니다.

4. 실시간 필터: 사이드바에 관련 키워드를 입력하면 특정 토픽을 빠르게 찾을 수 있습니다. 결과가 없으면 동일한 프롬프트로 더 깊은 검색을 수행하도록 안내됩니다.

5. 모바일 친화적: 새로운 사이드바는 데스크톱 뷰와 동일한 모든 기능을 갖추고 모바일에서도 완벽하게 작동합니다.

한번 살펴보세요

오늘 새로운 문서 사이드바를 실제로 확인해 볼 수 있습니다!

기대할 수 있는 내용을 더 잘 이해할 수 있도록 몇 가지 스크린샷을 공유합니다:

보시다시피, 사이드바는 모든 문서 섹션에 대한 명확한 개요를 제공하여 탐색을 매우 쉽게 만들어 줍니다.

각 카테고리는 정의된 섹션으로 나뉘어 그 안의 토픽을 보여줍니다.

현재 보고 있는 토픽은 쉽게 참조할 수 있도록 사이드바에서 강조 표시됩니다.

각 섹션은 접을 수 있어 필요한 콘텐츠를 더 쉽게 찾을 수 있습니다.

개별 섹션은 콘텐츠가 더 명확하게 보이도록 펼칠 수 있습니다.

최근 개선 사항에 기반하여

이 새로운 사이드바는 Discourse 문서 경험을 개선하기 위한 우리의 지속적인 노력의 일환입니다. 이는 개선된 명확성을 위해 문서를 재구성하기 위한 최근 작업을 기반으로 합니다. 새로운 사이드바는 재분류된 문서를 탐색하기 위한 직관적인 인터페이스를 제공하여 이러한 구조적 개선 사항을 보완합니다.

이것은 최근에 공개된 스타일 가이드와 일치하도록 모든 문서 토픽의 콘텐츠를 전면 개편하는 ongoing 작업과 함께 진행되고 있습니다. 이는 진행 중인 작업이므로, 이 과정을 통해 점진적인 개선 사항을 눈치채실 수 있습니다.

여러분의 피드백을 원합니다!

새로운 문서 사이드바를 사용해 보셨나요? 여러분의 의견을 듣고 싶습니다! 이 토픽에 여러분의 경험, 제안, 또는 질문이 있으시면 게시해 주세요.

전체적인 문서 작업에 대한 질문이나 피드백이 있다면, 이 토픽에서 알려 주세요.

Discourse 커뮤니티의 일원이 되어 주셔서 감사합니다. 이 새로운 기능이 여러분의 Discourse 경험을 어떻게 향상시킬지 기대하고 있습니다.

[Arkshine]

새로운 변경 사항 축하드립니다. 정말 멋진 변화입니다.

• 모든 카테고리에서 실시간 필터링
  현재 작동 방식이 다소 어렵게 느껴질 수 있습니다. 어떤 (하위) 카테고리에 있든 상관없이 필터링할 수 있으면 좋았을 것입니다. 이것이 제가 자연스럽게 가장 먼저 시도한 부분입니다:

물론 도움이 되는 링크들이 있으니 다행입니다. 대신 저는 다음과 같은 모습을 기대했습니다:

• ctrl + / 사용 시 콘텐츠가 위로 스크롤됨
  검색 입력창에 포커스를 맞추는 단축키를 사용할 때 사이드바와 콘텐츠가 모두 위로 스크롤됩니다. 여기서 콘텐츠가 위로 스크롤되는 것은 기대하지 않습니다.
  

• 맥락 인식 능력 상실
  필터를 사용하다가 주제를 클릭한 후 필터를 해제하면 하이라이트된 주제를 볼 수 없을 수 있습니다. 편집: 게시물에서 주제로 이동할 때도 마찬가지입니다.
  

• 주제 열람 시 접힌 섹션이 하이라이트되지 않음
  주제를 열람하면서 섹션을 접는 경우, 맥락상 해당 섹션을 어떻게든 하이라이트하거나 강조하는 것이 유용할 것 같습니다.

[ondrej]

좋은 추가/개선입니다!

이제 훨씬 더 쉽게 탐색할 수 있어요. 어디를 봐야 하는지가 훨씬 더 명확해졌거든요

조금 아쉬운 점이라면, 카테고리 순서와 내비게이션 사이드바의 순서가 일치하지 않는다는 거예요.

#documentation에서 마지막 3개 카테고리는 다음과 같습니다:

Documentation > Migrating to Discourse
Documentation > Contributing
Documentation > Developer Guides

하지만 내비게이션 사이드바에서는 #documentation:developer-guides와 #documentation:contributing의 순서가 바뀌어 있어요.

훌륭한 작업이었어요!

[JammyDodger]

일치하는 순서여야 하지 않나요?

다른 순서를 어디서 확인하고 계신가요?

[ondrej]

모바일에서 보고 있습니다.

[JammyDodger]

이상하군요. 왜 당신의 화면이 조금 다른지 모르겠어요.

제가 보는 내용은 다음과 같습니다:

또한 상자에 개발자 가이드 카테고리 설명이 없는 것 같아요. 카테고리를 음소거하거나 그런 조치를 취한 건가요?

[manuel (Manuel Kostka)]

다른 인스턴스에서도 이러한 카테고리 사이드바를 활성화할 수 있나요?

[Moin]

이것은 #customization:theme-component입니다. GitHub - discourse/discourse-docs-sidebar · GitHub.

[ondrej]

@JammyDodger

카테고리를 음소거하거나 그런 건 없나요?

아, 그게 문제였네요. 해결되었습니다! ;}

[mcwumbly (Dave McClure)]

@manuel

다른 인스턴스에서도 이러한 카테고리 사이드바를 활성화할 수 있나요?

@Moin

이것은 Customization > Theme component GitHub - discourse/discourse-docs-sidebar 입니다.

직접 수정해 보시는 것은 환영하지만, 우리가 완전히 지원할 수 있는 수준으로 만들기 위해서는 아직 해야 할 일이 많습니다.

사이드바의 UI를 구동하는 것은 인덱스 주제(index topics)를 유지 관리하는 것이며, 여기에는 상당한 오버헤드가 수반됩니다. 또한 카테고리 내 주제와 인덱스 주제가 항상 일치하도록 보장하는 내장 시스템이 없습니다.

우리는 현재 여기 문서 유지 관리에 따른 오버헤드를 감수하고 있으며, 여기에서 문서를 읽고 탐색하는 경험에 대한 피드백을 수집하는 데 중점을 두고 있습니다. 우리는 이 컴포넌트를 사용하여 문서를 유지 관리하는 것이 어떤지라는 피드백보다는, 바로 지금 그 종류의 피드백을 찾고 있습니다.

[Heliosurge (Dan DeMontmorency)]

정말 훌륭합니다. 정식 출시를 기대하고 있습니다.

[Jagster (Jakke Flemming)]

기존 것보다 훨씬 사용하기가 쉽습니다. 더… 명확하죠. 하지만 더 기술적인 성향의 사용자들은 이를 제한적으로 느낄 수 있을 것 같습니다.

사용자들이 필터링을 두려워하기 때문에, 필요할 때조차 문서를 사용하지 않습니다. 이 시스템은 사용자 친화적이 olacaktır.

하지만 관리자의 지속적인 관리와 관심이 필요하게 된다면…

[hugh (Hugh Lashbrooke)]

@Arkshine

ctrl + / 사용 시 콘텐츠가 위로 스크롤됨
…
맥락 인식 기능 상실
…
토픽을 볼 때 접힌 섹션이 강조되지 않음

이 문제들을 알려주셔서 감사합니다, @Arkshine! 모두 수정이 가능할 것 같으니, 여기서 어떻게 처리할 수 있는지 확인해 보겠습니다.

[Moin]

어떤 이유에선가 문서 사이드바가 검색 동작 방식을 변경합니다. 제 태블릿에서는 문서 사이드바가 표시되어 있을 때 엔터 키를 눌러 검색 결과를 가져올 수 없습니다. 사이드바가 표시될 때 '다음’이라고 표시되는데, '이동’이 아닌 이유를 모르겠습니다.

[saquetim (Sérgio Saquetim)]

문제를 재현할 수 없습니다.

방금 내 iPad에서 직접 테스트해 보았습니다.

아직도 발생하는지 확인해 주시겠어요?

[Moin]

여전히 발생하고 있습니다. Chrome과 Edge에서는 재현할 수 있지만, Firefox 앱에서는 재현되지 않습니다.

[saquetim (Sérgio Saquetim)]

그래도 재현이 안 됩니다. 문서 사이드바가 이런 문제를 일으킬 수 있다는 게 이해가 안 됩니다.

검색 코드에는 아무런 영향을 주지 않으니까요.

다른 원인일 수도 있습니다.

사용 중인 환경에 대해 더 자세한 정보를 제공해 주실 수 있을까요? 브라우저 버전, OS 등.

[Moin]

Galaxy Tab S9 FE
Android 14; SM-X510 Build/UP1A.231005.007
Chrome 126.0.6478.123

외장 키보드를 사용해 보았습니다. 이를 통해 엔터 키를 두 번 눌러야 하는 것 같다는 점을 확인할 수 있었습니다.

[saquetim (Sérgio Saquetim)]

네, Android에서 재현할 수 있습니다.

문제가 문서 사이드바에서만 발생하는 것이 아니라, 관리자 사이드바에서도 동일한 현상이 나타납니다.

문제를 조사해봐야 할 것 같습니다.

이미 무슨 일이 일어나고 있는지 알고 있습니다.

최선의 수정 방법을 내부에서 논의하겠습니다.

[saquetim (Sérgio Saquetim)]

다음으로 해당 문제를 해결할 수 있습니다:

DEV: Added enter hints for the quick search and sidebar filter (#28022)

이미 Meta에 적용되었습니다.