Removes DESIGN.textile doc and update ARCHITECTURE.md #1544
Conversation
| @@ -1,5 +1,9 @@ | |||
| [Back to Guides](README.md) | |||
|
|
|||
| This document focuses on architecture the 0.10.x version of ActiveModelSerializers. If you are interested in the architecture of the 0.8 or 0.9 versions, | |||
| please refer to the [0.8 README](https://github.com/rails-api/active_model_serializers/blob/0-8-stable/README.md) or | |||
| [0.9 README](https://github.com/rails-api/active_model_serializers/blob/0-9-stable/README.md). | |||
There was a problem hiding this comment.
@groyoh Thanks. We also want to reference the original design docs which was the impetus for this PR #1490 (comment)
There was a problem hiding this comment.
Added it below ;) Let me know if something is missing.
groyoh
force-pushed
the
remove_design
branch
from
e276015 to
fabf763
Compare
| please refer to the [0.8 README](https://github.com/rails-api/active_model_serializers/blob/0-8-stable/README.md) or | ||
| [0.9 README](https://github.com/rails-api/active_model_serializers/blob/0-9-stable/README.md). | ||
|
|
||
| The original design is also available [here](https://github.com/rails-api/active_model_serializers/blob/0-9-stable/DESIGN.textile). |
There was a problem hiding this comment.
I'd rather link to one of the original docs
[serializers.textile in Rails (before reverted)](https://github.com/rails/rails/blob/fcacc6986ab60f1fb2e423a73bf47c7abd7b191d/railties/guides/source/serializers.textile)and[README.textile in first 0.0.1 commit](https://github.com/rails-api/active_model_serializers/commit/d72b66d4c5355b0ff0a75a04895fcc4ea5b0c65e?short_path=8aa641a#diff-8aa641a619b8ebeca0116d41774daf45)
There was a problem hiding this comment.
Changed it to the first commit.
The old DESIGN.textile was removed and replace by reference to 0.8 and 0.9 READMEs within the ARCHITECTURE.md docs.
groyoh
force-pushed
the
remove_design
branch
from
fabf763 to
8b5da69
Compare
|
I'll kill Travis, since it's only documentation change. |
|
Or add [ci skip] to the commit
|
|
Holy sheep! I didn't know this trick. |
|
@bf4 any other thoughts on this? |
|
This looks good to me. |
[DOC] Removes DESIGN.textile doc and update ARCHITECTURE.md [ci skip]
Purpose
Rebase #1490 and add missing changes.
Changes
Removes the
DESIGN.textilefile and adds references to the 0.8 and 0.9 READMES within theARCHITECTURE.mdfile.Additional helpful information
Closes #1490.