Comments (4)
I agree with @Insti that the current setup definitely is confusing. Something can be said for splitting contributing to a track from maintaining a track, as the latter does involve the former, but not vice versa.
from legacy-docs.
I also agree with all of this. I find it very difficult to locate documents that I recall reading at one time, but now have been relocated or maybe the contents moved to another place. When I would like to cite a document to someone I end up stuck. Unfortunately I don't have ideas on how to resolve this. Perhaps some sort of TOC that starts at the repo level and then drills down maybe would help shine some light on how the documentation flows (or doesn't flow).
from legacy-docs.
The README seems like a logical place to link to each doc and describe its purpose.
from legacy-docs.
I'm aware that it's confusing. I've generally been adding documentation and trying to find groups of content that make sense together, and haven't found the final location for anything.
There are two types of content so far.
- reference documentation: by topic, as complete and detailed as possible (e.g. "track configuration") https://github.com/exercism/docs/tree/master/language-tracks/configuration
- guides: you have a starting point, a document that gives you a mental map of how to process things, which links out to reference documentation along the way. E.g. https://github.com/exercism/docs/blob/master/language-tracks/launch/README.md
I mostly add documentation after having a conversation with a contributor or maintainer, and discovering that we're missing something.
from legacy-docs.
Related Issues (20)
- Wrong link on website HOT 2
- Is unlocked-by always required for non-core exercises? HOT 2
- language-tracks/configuration/exercises.md - document reasons a topic should be added HOT 5
- Mention ordering in configuration/exercises.md
- Exercises based on problems with multiple solutions HOT 2
- I Can Read C++ and Java But I Canβt Read Smalltalk HOT 7
- Request guidance for how to select the list of core exercises HOT 1
- Maintainer docs point to archived repo HOT 1
- Tools repository does not exist HOT 1
- Docs issue: Unable to find "contributing" section in sidebar HOT 2
- Mentor comment box missing tabbing HOT 2
- Track configuration directory lacks document about canonical_data_syncer
- The master branch will be renamed to main HOT 1
- Add documentation about track contributing documentation HOT 4
- Add documentation about track tooling, automation, and bots
- Update contributing guides for maintainers
- first-exercise.md: ends abruptly HOT 3
- Should implement-an-exercise-from-specification.md#configuring-the-exercise include nextercism keys? HOT 2
- Finish incomplete sentence HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. πππ
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google β€οΈ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from legacy-docs.