Skip to content
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

Formatting Guidelines For Note Libraries #260

Open
Legendsmith opened this issue Dec 9, 2023 · 5 comments
Open

Formatting Guidelines For Note Libraries #260

Legendsmith opened this issue Dec 9, 2023 · 5 comments
Labels
enhancement New feature or request

Comments

@Legendsmith
Copy link
Contributor

Legendsmith commented Dec 9, 2023

Lets say hypothetically I am making a Note Library to encourage the use of Markdown Expressions by providing useful premade ones.
How should I format these?
Is one library of "useful notes" fine?
Should I break it up (Powers, Basic, set, etc?)
What about the formatting of the Notes themselves? Use of headings?
image

@richardwilkes
Copy link
Owner

I'd start with a single file, perhaps using containers within it to group things, if needed. We can always break it up into smaller files later.

That said, if the content was very specific to a given book (say, Powers), then it might make sense to create one for that and co-locate it with the Power data.

@richardwilkes
Copy link
Owner

This is a great idea and use of the markdown + calc feature, btw.

@Legendsmith
Copy link
Contributor Author

Legendsmith commented Dec 10, 2023

I'm glad you agree! When I saw the markdown with calc, I knew was one of the best features you've ever added: . It's also why I brought up richardwilkes/gcs#771, so all this can still be useful upon export. If we can get people using these to their full potential I believe it can save numerous headaches, mostly in the form of stemming the requests for support for hyperspecific rules.

That said, if the content was very specific to a given book (say, Powers), then it might make sense to create one for that and co-locate it with the Power data.

Yeah, that was my thought. People are going to be looking in the folders for such things to begin with. That said, I'm not sure what to call such a file in the first place. Powers Notes? That's not very descriptive that it's packed full of time-saving, auto calculating notes. Suggestions very welcome.

@richardwilkes richardwilkes added the enhancement New feature or request label Dec 10, 2023
@richardwilkes
Copy link
Owner

@rinickolous do you have any suggestions for this?

@rinickolous
Copy link
Collaborator

The formatting you're currently doing for these notes is fine.

Struggling to think of a good format for names too. "X Quick Values"? "X Statistics"?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants