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.