ms-structural / ms-structural/femdesign-api
Update C# "Getting started" text on docs
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 51
- Forks
- 29
- PR merge metrics
- No merged PRs in 30d
Description
Could we just add the paragraph with the information below from Github to the docs page? It is not evident if you start reading in docs how you should run the examples, but the info on Github is helpful
👩💻 C#
To properly run the C# examples, we recommend that you clone the entirety of the FEM-Design API repository with Git. You can find instructions for this here. You can also download the entire repository as a .zip file and unpack it on your computer.
There are two ways to run the C# examples: either find a specific example in the femdesign-api/FemDesign.Examples/C# folder, then open the project file (.csproj) found there and run the program. Or, open the main solution (femdesign-api.sln) found in the femdesign-api folder, and select which of the example projects you want to run.
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
Find the documentation page containing the C# “Getting started” text. Add the supplied guidance about cloning or downloading the repository and running examples through their .csproj files or the main solution, then verify the rendered links and wording.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100