> but the original documentation may look weird[1] Yes, if we choose to provide a better Reading Experience for Developers, we need to update Markdown files like Docusaurus[1] does, but the rendered page[2] is really good than GitHub Markdown.
For now, I would support we could focus on improving the contents of the doc, to let it more smoothly and easily for newcomers and us :) That's the core of our Developer Experience IMO. [1] https://github.com/facebook/docusaurus/blob/main/website/docs/deployment.mdx [2] https://docusaurus.io/docs/deployment Best Regards! @ Zhiyuan Ju <https://github.com/juzhiyuan> Tsangleslie <[email protected]> 于2021年11月19日周五 上午10:19写道： > Hi there, > 😂, Sorry for the misunderstanding. I meant was that we will keep > the documentation in Apache APISIX repo, but the original documentation may > look weird[1] on GitHub website view as GitHub doesn’t support these > markdown syntaxes, like MDX and Heading IDS. > For those offline developer, this change may cause a hard time in > reading the documentation. > > [1] > https://github.com/facebook/docusaurus/blob/main/website/docs/deployment.mdx > <https://github.com/facebook/docusaurus/pull/5888/files> > > > > On 19 Nov 2021, at 9:34 AM, Chao Zhang <[email protected]> wrote: > > > > Hi, there > > > > I’m not familiar with the website maintainment and design, so if we drop > > the support of docs on GitHub, where should we put these document > > materials? Just put them in the website repository? > > > > Chao Zhang > > https://github.com/tokers <https://github.com/tokers> > > > > On November 18, 2021 at 14:18:43, Tsangleslie ( > > [email protected] <mailto:[email protected]>) > wrote: > > > > Hi community, > > Currently, Apache APISIX project documentation need to take of both > GitHub > > and official website versions, which cause a lot of special design and > > large differences in reading experience, I propose to cancel the > > maintenance of GitHub version to ensure maintainer’s time can be used > most > > efficiently on the official website version. > > > > Here is the point why we should cancel the GitHub version: > > - Better i18n support for documentation, ref to APISIX issue #5392[1] > > - Better markdown support for unofficial feature, since GitHub markdown > > doesn't support them > > - More traffic view on APISIX Website, which would also help people > > understand what is happening in the community > > > > Please let me know if you have any suggestions, improvements, > > modifications. > > > > [1] https://github.com/apache/apisix/pull/5392 < > > https://github.com/apache/apisix/pull/5392 < > https://github.com/apache/apisix/pull/5392>> > > > > Leslie Tsang > > [email protected] <mailto:[email protected]> >
