coala / coala/projects

GitBook English edit support

Open
#399 1 comment 0 reactions 0 assignees View on GitHub
design upstream
Dominant language
JavaScript
Stars
118
Forks
225
PR merge metrics
No merged PRs in 30d

Description

After https://github.com/coala/projects/issues/64, the GitBook is readable

https://coala.gitbooks.io/projects/content/

The English README.md and SUMMARY.md are editable, and the bahasa is editable.

However the English pages are not editable, due to https://github.com/GitbookIO/gitbook/issues/1906 / https://github.com/GitbookIO/gitbook/issues/1905 . I have a few other ideas for how to get around this.

An alternative is to move our `_projects` and `_faq` into `data/locale/en` to conform with GitBook expectations, which would require a change to the JS site also.

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the current `_projects`, `_faq`, English `README.md`, and `SUMMARY.md` content alongside the linked GitBook issues. Compare the proposed `data/locale/en` layout with the JavaScript site before choosing an approach. Done means English GitBook pages are editable without breaking the site.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.