प्रस्तुति

यह दस्तावेज़ बताता है कि अलग-अलग अभ्यास और ट्रैक की फाइलें विद्यार्थी को कैसे दिखाई जाती हैं। साथ ही इसमें यह भी ध्यान रखा जाता है कि विद्यार्थी CLI इस्तेमाल कर रहे हैं या एडिटर।

डॉक्यूमेंटेशन

डॉक्यूमेंटेशन तीन तरह का होता है, और यही तय करता है कि किसी अभ्यास के लिए कौन-सा डॉक्यूमेंटेशन दिखाया जाएगा।

अभ्यास-विशेष फाइलें

ये फाइलें हर अभ्यास के लिए अलग होती हैं:

• .docs/introduction.md: उन कॉन्सेप्ट का परिचय देना जो यह अभ्यास विद्यार्थी को सिखाता है (आवश्यक)
• .docs/introduction.append.md: मौजूदा परिचय के बाद जोड़ने के लिए अतिरिक्त परिचय पाठ (कॉन्सेप्ट अभ्यासों में इस्तेमाल नहीं होता, प्रैक्टिस अभ्यासों के लिए वैकल्पिक)
• .docs/instructions.md: अभ्यास के लिए निर्देश देना (आवश्यक)
• .docs/instructions.append.md: मौजूदा निर्देशों के बाद जोड़ने के लिए अतिरिक्त परिचय पाठ (कॉन्सेप्ट अभ्यासों में इस्तेमाल नहीं होता, प्रैक्टिस अभ्यासों के लिए वैकल्पिक)
• .docs/hints.md: विद्यार्थी को संकेत देकर मदद करना, ताकि अभ्यास में अटकने पर वे खुद आगे बढ़ सकें (कॉन्सेप्ट अभ्यासों के लिए आवश्यक, प्रैक्टिस अभ्यासों के लिए वैकल्पिक)
• .meta/config.json: अभ्यास की स्रोत जानकारी रखता है (वैकल्पिक)

अधिक जानकारी के लिए कॉन्सेप्ट अभ्यासों का डॉक्यूमेंटेशन और प्रैक्टिस अभ्यासों का डॉक्यूमेंटेशन देखिए।

ट्रैक-विशेष फाइलें

ये फाइलें सभी अभ्यासों के बीच साझा होती हैं:

• debug.md: बताता है कि ब्राउज़र में कोडिंग करने वाले विद्यार्थी "डीबगिंग" कैसे कर सकते हैं (वैकल्पिक)
• help.md: मदद कैसे पाई जाए, इस पर ट्रैक-विशेष निर्देश रखता है (आवश्यक)
• representations.md: बताता है कि किसी हल का रिप्रेजेंटेशन बनाने के लिए उस पर कौन-से नॉर्मलाइज़ेशन लागू किए जाते हैं (वैकल्पिक)
• tests.md: टेस्ट कैसे चलाएँ, इस पर ट्रैक-विशेष निर्देश रखता है (आवश्यक)

अधिक जानकारी के लिए साझा फाइलों का डॉक्यूमेंटेशन देखिए।

Exercism-व्यापी डॉक्यूमेंटेशन

ऊपर दी गई ट्रैक/अभ्यास-विशेष डॉक्यूमेंटेशन फाइलों के अलावा दो और चीज़ें हैं जो पूरे Exercism पर लागू होती हैं (और इस तरह सभी ट्रैक में साझा होती हैं):

• CLI से अभ्यास सबमिट करने के निर्देश
• मदद पाने के निर्देश

एडिटर

ब्राउज़र में किसी अभ्यास पर काम करते समय डॉक्यूमेंटेशन फाइलें सही समय पर दिखाई देती हैं। उदाहरण के लिए, संकेत तब तक नहीं दिखाए जाते जब तक विद्यार्थी उन्हें दिखाने के लिए न कहें। एडिटर को CLI के निर्देश दिखाने की भी ज़रूरत नहीं होती।

CLI

CLI के ज़रिए अपने कंप्यूटर पर काम करते समय हमारे पास डॉक्यूमेंटेशन को शर्त के हिसाब से दिखाने का विकल्प नहीं होता। इसलिए CLI को हमेशा सारा संबंधित डॉक्यूमेंटेशन डाउनलोड करना पड़ता है। विद्यार्थी को कई फाइलें खोलनी न पड़ें, इसके लिए CLI सारे संबंधित डॉक्यूमेंटेशन को जोड़कर तीन दस्तावेज़ बना देता है:

README.md

इस फाइल में अभ्यास के निर्देश, परिचय (वैकल्पिक) और स्रोत जानकारी (वैकल्पिक) होती है।

# [exercise name]

Welcome to [exercise name] on Exercism's [track name] Track.
If you need help running the tests or submitting your code, check out `HELP.md`.
If you get stuck on the exercise, check out `HINTS.md`, but try and solve it without using those first :)

## Introduction (optional)

[Exercise-specific file: .docs/introduction.md] (optional)

[Exercise-specific file: .docs/introduction.append.md] (optional)

## Instructions

[Exercise-specific file: .docs/instructions.md]

[Exercise-specific file: .docs/instructions.append.md] (optional)

## Source

### Created by

- @[author-1 handle]
- @[author-2 handle]
  ...

### Contributed to by (optional)

- @[contributor-1 handle]
- @[contributor-2 handle]
  ...

### Based on

[source] - [source url]

HELP.md

यह फाइल बताती है कि टेस्ट कैसे चलाएँ, साथ ही इसमें ट्रैक और पूरे Exercism के लिए मदद के निर्देश भी होते हैं।

# Help

## Running the tests

[Track-specific file: exercises/shared/.docs/tests.md]

## Submitting your solution

[Exercism-wide documentation: instructions on how to submit a solution]

## Need to get help?

[Exercism-wide documentation: instructions on how to get help]

[Track-specific file: exercises/shared/.docs/help.md]

HINTS.md

इस फाइल में अभ्यास-विशेष संकेत होते हैं (वैकल्पिक)

# Hints

## General

- Consider extracting the logic to a helper function.