ms-structural / ms-structural/femdesign-api

Wiki/documentation: Graph over files and API structure and explain files

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

Nobody has claimed this yet.

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

Description

Graph over files and API structure?
  • Diagram over how the files relate to each other?
Explain the files
  • .struxml
  • .str
  • .strFEM
  • .str.lck
  • .fdscript
  • .bsc
  • .dsc
  • logfile.log
  • .txt (result)
  • .csv (result)

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

Start by reviewing the repository's API structure and the relationships among the files mentioned in the issue: .struxml, .str, .strFEM, .str.lck, .fdscript, .bsc, .dsc, logfile.log, .txt, and .csv. Document what each file represents and add a diagram showing how they relate; the work is done when all checklist items are covered in the wiki or documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.