ARMmbed / ARMmbed/mbed-drivers
Doxygen frontpage - avoid duplication
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 39
- Forks
- 41
- PR merge metrics
- No merged PRs in 30d
Description
This is a tracking issue for a question asked in #178. This PR added a new doxygen frontpage file, which is a duplicate of readme.md.
The reason of this addition is:
Currently the docs site does not support user-provided Doxyfiles, but this could change in the near future.
Once the docs site supports user-readme, we should remove it. We shall for now keep an eye on this duplication (if any change to the readme, we should add it to the frontpage file).
cc @micque01 @iriark01
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing issue #178 and comparing the Doxygen frontpage file with readme.md. Check whether the documentation site now supports user-provided Doxyfiles or user-readme; completion depends on that support being available, after which the duplicate frontpage can be removed.
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
- 25/100