ms-structural / ms-structural/femdesign-api

`Basics` in Doc website are not link from FEM-Design API repository

Open
#878 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type:question
Dominant language
C#
Stars
51
Forks
29
PR merge metrics
No merged PRs in 30d

Description

There is a not consistent decision regarding the example and basics file in the documentation website.

Examples in doc are linked from FEM-Design Repository
Basics in doc are NOT linked from FEM-Design Repository

Is it an issue for us?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the documentation website's Examples and Basics sections and the FEM-Design Repository links mentioned in the issue. Determine whether Basics should link to repository files like Examples do; the work is done when the linking convention is decided and applied consistently.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.