graphql/graphiql

Unify doc explorer navigation around schema reference concept

Open

#298 建立於 2017年1月25日

在 GitHub 查看
 (1 留言) (1 反應) (0 負責人)TypeScript (15,473 star) (1,785 fork)batch import
enhancementgraphiqlhelp wantedresolved-by-monaco

描述

As defined in https://github.com/graphql/codemirror-graphql/blob/master/src/utils/SchemaReference.js - SchemaReference gives us a serializable way to refer to different parts of a schema.

Ideally this general utility is moved into a place where it can be leveraged more broadly (graphql-js perhaps) along with serialization and deserialization utilities.

This would make a better general public API for navigating to any element, and would give codemirror-graphql a better interface for interoperating with any kind of documentation browser.

It would also unlock issues like #77 by allowing a serialization of the currently viewed doc

貢獻者指南

技術棧
javascripttypescript
領域
frontenddeveloper experiencedocumentation
議題類型
refactor
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
4
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
3-5 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
GraphQL schema conceptsJavaScript/TypeScriptcodebase navigationrefactoring experience
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
25
研究方向
Examine the SchemaReference utility in codemirror graphql (utils/SchemaReference.js) to understand its current interface and functionality. Study the graphql js repository to identify an appropriate location for the moved utility. Review issue #77 for context on serialization needs. Investigate if any existing serialization utilities in graphql js can be leveraged or extended. Engage with maintainers to clarify the desired API and acceptance criteria before implementation.