ampproject / ampproject/amppackager

Update docs more frequently

Open
#302 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
141
Forks
46
PR merge metrics
No merged PRs in 30d

Description

The release process introduced in #169 mean that all our changes to `.md` file aren't visible until a packager release. Either:

1. Move all the docs to wiki.
1. Regularly merge changes in `.md` files from `master` to `releases`.
1. Keep `.md` files only on the `release` branch.

I'm partial to the first. The other two seem like they might cause `git` consternation.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the release process introduced in issue #169 and how `.md` files move between `master` and `releases`. Compare the three listed approaches, document the chosen approach, and confirm that documentation changes become visible without waiting for a packager release.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, markdown
Domain
documentation, release
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.