-
Notifications
You must be signed in to change notification settings - Fork 22
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Reorganize README #265
Comments
Yes, I think this is long overdue. Would you like me to move the rest of the README into wiki pages? I would split it up into multiple pages. |
@ToddFincannonEI: I started working on the reorg already, so I can take care of it. My plan was to move the developer and architecture parts into separate md files in the docs directory for now to make the review easier (so that you can see where things were moved to all at once). Once I submit the PR, we can decide whether those should live in the repo (in FWIW, I like using the wiki for things like architecture that are less likely to change over time and that aren't tightly bound to a current revision of the repo. Also, it's easier to make quick edits to the wiki. For things like developer guides or API docs that refer to a specific (current) revision of the repo, sometimes a |
The current README is very thorough, but it contains a mix of user-facing (installation, usage) and developer-facing (debugging, architectural) documentation, so it may be overwhelming to new users. Both kinds of documentation are important, but I think it would be better to have the succinct user-facing docs in the README, and move the developer-facing docs to the wiki or a separate
docs
folder.Additionally, all the new packages that have been added in recent months haven't yet been mentioned in the README, mostly because I've been waiting to revisit how the README is organized.
For the new README, I propose the following structure:
npm create @sdeverywhere
)@sdeverywhere
packages, with links to docs+changelog for each)As part of this, I will need to revisit the "Using SDEverywhere to Make a Vensim Model into a Web Application" document and update it to account for the new build/plugin system, or just fold the changes into the README.
Checklist of things to resolve as part of this work:
DEPRECIATE STRAIGHTLINE
fiscal period argument being unsupported (see feat: implement DEPRECIATE STRAIGHTLINE #264 (review))The text was updated successfully, but these errors were encountered: