domthom21/eurocodedesign

[ENH] Add planned structure to documentation for developers

Open

#59 opened on Jul 24, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (1 fork)auto 404
enhancementgood first issue

Repository metrics

Stars
 (8 stars)
PR merge metrics
 (PR metrics pending)

Description

Is your feature request related to a problem? Please describe. Planned structure:

  • standard
    • ec3
      • crosssection
        • classification
        • verification
      • platebuckling

Add to doc

Contributor guide

Research direction
Examine the current documentation structure in the repository and add the planned hierarchy: standard > ec3 > crosssection (classification, verification) and platebuckling.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95