iiasa / iiasa/message_doc

Separate section for detailed technologies description

Open
#37 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TeX
Stars
8
Forks
17
PR merge metrics
No merged PRs in 30d

Description

To keep individual sections concise/to prevent over-cluttering throughout the documentation, while still having enough detail, it might be worthwhile adding a separate section that features an overview with more detailed technology descriptions.
(Previously proposed e.g. [here](https://github.com/iiasa/message_doc/pull/24/#issuecomment-557005769))

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the existing documentation sections and the proposal in pull request 24's referenced comment. Define the separate overview section and confirm that individual sections remain concise while the new section provides detailed technology descriptions.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.